org.trypticon.hex.anno.MemoryAnnotationCollection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hex-anno Show documentation
API for annotating runs of binary with arbitrary annotations
There is a newer version: 0.8.0
/*
 * Hex - a hex viewer and annotator
 * Copyright (C) 2009-2014  Trejkaz, Hex Project
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 */

package org.trypticon.hex.anno;

import java.util.LinkedList;
import java.util.List;


/**
 * A collection of annotations kept in memory.
 *
 * @author trejkaz
 */
public class MemoryAnnotationCollection extends AbstractAnnotationCollection {
    private final GroupAnnotation rootGroup;

    public MemoryAnnotationCollection(long length) {
        rootGroup = new SimpleGroupAnnotation(0, length);
    }

    public MemoryAnnotationCollection(GroupAnnotation rootGroup) {
        this.rootGroup = rootGroup;
    }

    @Override
    public GroupAnnotation getRootGroup() {
        return rootGroup;
    }

    @Override
    public List getTopLevel() {
        return rootGroup.getAnnotations();
    }

    @Override
    public List getAnnotationPathAt(long position) {
        if (position < 0) {
            return null;
        }

        List path = null;
        Annotation annotation = rootGroup;

        while (annotation instanceof GroupAnnotation) {
            annotation = ((GroupAnnotation) annotation).findAnnotationAt(position);
            if (annotation == null) {
                break;
            }

            if (path == null) {
                path = new LinkedList<>();
            }
            path.add(annotation);
        }

        return path;
    }

    @Override
    public List getAnnotationPathFor(Annotation annotation) {
        List path = new LinkedList<>();
        path.add(rootGroup);
        GroupAnnotation ancestor = rootGroup;
        while (true) {
            Annotation next = ancestor.findAnnotationAt(annotation.getPosition());
            if (next == null) {
                throw new IllegalArgumentException("Annotation is not in the collection: " + annotation);
            }

            path.add(next);
            if (next == annotation) {
                // Found it.
                return path;
            }

            if (next instanceof GroupAnnotation) {
                ancestor = (GroupAnnotation) next;
            } else {
                // Found a leaf, so the annotation can't be in the collection.
                throw new IllegalArgumentException("Annotation is not in the collection: " + annotation);
            }
        }
    }
}