org.monte.media

Class FormatKey<T>

java.lang.Object

org.monte.media.FormatKey<T>

All Implemented Interfaces:

Serializable, Comparable

public class FormatKey<T>
extends Object
implements Serializable, Comparable

A FormatKey provides type-safe access to an attribute of a Format.

A format key has a name, a type and a value.

Version:

$Id: FormatKey.java 299 2013-01-03 07:40:18Z werner $

Author:

Werner Randelshofer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
FormatKey(String key, Class<T> clazz) Creates a new instance with the specified attribute key, type token class, default value null, and allowing null values.
FormatKey(String key, String name, Class<T> clazz) Creates a new instance with the specified attribute key, type token class, default value null, and allowing null values.
FormatKey(String key, String name, Class<T> clazz, boolean comment) Creates a new instance with the specified attribute key, type token class, default value null, and allowing null values.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(FormatKey that)
int	compareTo(Object o)
String	getKey() Returns the key string.
String	getName() Returns the pretty name string.
Class	getValueClass()
boolean	isAssignable(Object value) Returns true if the specified value is assignable with this key.
boolean	isComment()
String	toString() Returns the key string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

FormatKey

public FormatKey(String key,
         Class<T> clazz)

Creates a new instance with the specified attribute key, type token class, default value null, and allowing null values.

FormatKey

public FormatKey(String key,
         String name,
         Class<T> clazz)

Creates a new instance with the specified attribute key, type token class, default value null, and allowing null values.

FormatKey

public FormatKey(String key,
         String name,
         Class<T> clazz,
         boolean comment)

Creates a new instance with the specified attribute key, type token class, default value null, and allowing null values.

Method Detail

getKey

public String getKey()

Returns the key string.

Returns:

key string.

getName

public String getName()

Returns the pretty name string.

Returns:

name string.

toString

public String toString()

Returns the key string.

Overrides:

toString in class Object

isAssignable

public boolean isAssignable(Object value)

Returns true if the specified value is assignable with this key.

Parameters:

value -

Returns:

True if assignable.

isComment

public boolean isComment()

getValueClass

public Class getValueClass()

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable

compareTo

public int compareTo(FormatKey that)