org.trypticon.hex.interpreters.InterpreterStorage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hex-interpreter Show documentation
API for interpreting runs of binary as values humans can understand
The newest version!
/*
 * Hex - a hex viewer and annotator
 * Copyright (C) 2009-2014,2016-2017  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.interpreters;

import java.util.List;
import java.util.Map;

/**
 * Interface describing a collection of interpreters which can be used
 * to interpret values.  Provides support for converting these to and from
 * map form, for serialisation purposes.
 *
 * @author trejkaz
 */
public interface InterpreterStorage {
    /**
     * Gets a list of information about all interpreters this storage utility knows about,
     * grouping together options with common behaviour, e.g. all the types which are essentially
     * the same can be grouped together into a single interpreter for handling that type with
     * different lengths, or big and little endian implementations can be grouped together into
     * a single interpreter info which allows choosing the endianness.
     *
     * @return the list of interpreter info.
     */
    List getGroupedInterpreterInfos();

    /**
     * Gets a list of information about all interpreters this storage utility knows about.
     *
     * @return the list of interpreter info.
     */
    List getInterpreterInfos();

    /**
     * Converts an interpreter into a map.  The returned map generally
     * has a "name" property containing the interpreter name, which needs
     * to be unique across the whole system.
     *
     * XXX: Because it has to be unique, should the names be namespaced?
     *
     * @param interpreter the interpreter.
     * @return the map.  Returns {@code null} if the interpreter is not one
     *         known by this storage.
     */
    Map toMap(Interpreter interpreter);

    /**
     * Converts a map into an interpreter.
     *
     * @param map the map.
     * @return the interpreter.  Returns {@code null} if this storage does not
     *         know about an interpreter with the name specified in the map.
     */
    Interpreter fromMap(Map map);
}