net.talvi.puffinplot.data.file

Class SimpleOptionDefinition

java.lang.Object

net.talvi.puffinplot.data.file.SimpleOptionDefinition

All Implemented Interfaces:

OptionDefinition

public class SimpleOptionDefinition
extends java.lang.Object
implements OptionDefinition

A simple implementation of the OptionDefinition interface.

Constructor Summary

Constructors

Constructor and Description
SimpleOptionDefinition(java.lang.String identifier, java.lang.String description, java.lang.Class type, java.lang.Object defaultValue, boolean required)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getDefaultValue() Returns a default value for the option.
java.lang.String	getDescription()
java.lang.String	getIdentifier()
java.lang.Class	getType()
boolean	isRequired() Returns true if and only if this option is required.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.talvi.puffinplot.data.file.OptionDefinition

getValue

Constructor Detail

SimpleOptionDefinition

public SimpleOptionDefinition(java.lang.String identifier,
                              java.lang.String description,
                              java.lang.Class type,
                              java.lang.Object defaultValue,
                              boolean required)

Parameters:

identifier - short option identifier

description - user-friendly option description

type - the class of the values taken by this option

defaultValue - the default value. It must be an instance of type

required - whether this option is required

Method Detail

getIdentifier

public java.lang.String getIdentifier()

Specified by:

getIdentifier in interface OptionDefinition

Returns:

a short, unique identifier for the option

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface OptionDefinition

Returns:

a user-friendly description of the option

getType

public java.lang.Class getType()

Specified by:

getType in interface OptionDefinition

Returns:

the class of the option's value

getDefaultValue

public java.lang.Object getDefaultValue()

Description copied from interface: OptionDefinition

Returns a default value for the option. The default value must be an instance of the class returned by getType(). The implementer should return either an immutable value or a defensive copy. null is a valid return value, and is returned by the default implementation. If this is a required option, the return value of this method should never be used; in this case, null is probably the most appropriate value to return.

Specified by:

getDefaultValue in interface OptionDefinition

Returns:

the default value of the option

isRequired

public boolean isRequired()

Description copied from interface: OptionDefinition

Returns true if and only if this option is required. The default implementation returns false.

Specified by:

isRequired in interface OptionDefinition

Returns:

true if this is a required (compulsory) option; false otherwise