ru.sbtqa.monte.media.FormatKey Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of monte-media
monte-media description
There is a newer version: 1.1.0-JAVA7
/* @(#)FormatKey.java  
 * Copyright © 2011 Werner Randelshofer, Switzerland. 
 * You may only use this software in accordance with the license terms.
 */
package ru.sbtqa.monte.media;

import java.io.Serializable;

/**
 * A FormatKey provides type-safe access to an attribute of a
 * {@link Format}.
 * 
 * A format key has a name, a type and a value.
 *
 * @author Werner Randelshofer
 * @version $Id: FormatKey.java 364 2016-11-09 19:54:25Z werner $
 * @param  TODO
 */
public class FormatKey implements Serializable, Comparable> {

    public static final long serialVersionUID = 1L;
    /**
     * Holds a String representation of the attribute key.
     */
    private String key;
    /**
     * Holds a pretty name. This can be null, if the value is self-explaining.
     */
    private String name;
    /**
     * This variable is used as a "type token" so that we can check for
     * assignability of attribute values at runtime.
     */
    private Class clazz;

    /**
     * Comment keys are ignored when matching two media formats with each other.
     */
    private boolean comment;

    /**
     * Creates a new instance with the specified attribute key, type token
     * class, default value null, and allowing null values.
     *
     * @param key TODO
     * @param clazz TODO
     */
    public FormatKey(String key, Class clazz) {
        this(key, key, clazz);
    }

    /**
     * Creates a new instance with the specified attribute key, type token
     * class, default value null, and allowing null values.
     *
     * @param key TODO
     * @param name TODO
     * @param clazz TODO
     */
    public FormatKey(String key, String name, Class clazz) {
        this(key, name, clazz, false);
    }

    /**
     * Creates a new instance with the specified attribute key, type token
     * class, default value null, and whether the key is just a comment.
     *
     * @param key TODO
     * @param name TODO
     * @param clazz TODO
     * @param comment TODO
     */
    public FormatKey(String key, String name, Class clazz, boolean comment) {
        this.key = key;
        this.name = name;
        this.clazz = clazz;
        this.comment = comment;
    }

    /**
     * Returns the key string.
     *
     * @return key string.
     */
    public String getKey() {
        return key;
    }

    /**
     * Returns the pretty name string.
     *
     * @return name string.
     */
    public String getName() {
        return name;
    }

    /**
     * Returns the key string.
     */
    @Override
    public String toString() {
        return key;
    }

    /**
     * Returns true if the specified value is assignable with this key.
     *
     * @param value TODO
     * @return True if assignable.
     */
    public boolean isAssignable(Object value) {
        return clazz.isInstance(value);
    }

    public boolean isComment() {
        return comment;
    }

    public Class getValueClass() {
        return clazz;
    }

    @Override
    public int compareTo(FormatKey that) {
        return this.key.compareTo(that.key);
    }
}