org.trypticon.hex.interpreters.InterpreterInfo 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 org.trypticon.hex.util.Format;
import org.trypticon.hex.util.Localisable;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.ResourceBundle;

/**
 * Holds information about an interpreter.
 *
 * @author trejkaz
 */
public interface InterpreterInfo extends Localisable {

    /**
     * Gets the list of options supported by the interpreter.
     * If there are no options this should return an empty list.
     *
     * @return the list of supported options.
     */
    List> getOptions();

    /**
     * Creates a new interpreter with the provided options.
     *
     * @param options the options.
     * @return the interpreter.
     */
    Interpreter create(Map options);

    /**
     * Class describing options which can be passed to the interpreter.
     */
    class Option implements Localisable {
        private final String name;
        private final Class type;
        private final boolean required;
        private final List values;

        public Option(String name, Class type, boolean required) {
            this(name, type, required, Collections.emptyList());
        }

        public Option(String name, Class type, boolean required, List values) {
            this.name = name;
            this.type = type;
            this.required = required;
            this.values = Collections.unmodifiableList(new ArrayList<>(values));
        }

        public String getName() {
            return name;
        }

        @Override
        public String toLocalisedString(Format style) {
            return toLocalisedString(style, Locale.getDefault());
        }

        @Override
        public String toLocalisedString(Format style, Locale locale) {
            return ResourceBundle.getBundle("org/trypticon/hex/interpreters/Bundle").getString("Option." + getName());
        }

        public Class getType() {
            return type;
        }

        public boolean isRequired() {
            return required;
        }

        public List getValues() {
            return values;
        }
    }
}