org.crsh.plugin

Class PropertyDescriptor<T>

java.lang.Object

org.crsh.plugin.PropertyDescriptor<T>

public abstract class PropertyDescriptor<T>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Map<java.lang.String,PropertyDescriptor<?>>	ALL .
T	defaultValue .
java.lang.String	description .
java.lang.String	name .
boolean	secret .
static java.lang.String	SECRET_DISPLAY_VALUE The display value returned when a property is secret.
java.lang.Class<T>	type .
static PropertyDescriptor<java.lang.Integer>	VFS_REFRESH_PERIOD .
static PropertyDescriptor<java.util.concurrent.TimeUnit>	VFS_REFRESH_UNIT .

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PropertyDescriptor(java.lang.Class<T> type, java.lang.String name, T defaultValue, java.lang.String description) Create a new property descriptor.
protected	PropertyDescriptor(java.lang.Class<T> type, java.lang.String name, T defaultValue, java.lang.String description, boolean secret) Create a new property descriptor.

Method Summary

Methods

Modifier and Type	Method and Description
static PropertyDescriptor<java.lang.Integer>	create(java.lang.String name, java.lang.Integer defaultValue, java.lang.String description)
static PropertyDescriptor<java.lang.Integer>	create(java.lang.String name, java.lang.Integer defaultValue, java.lang.String description, boolean secret)
static PropertyDescriptor<java.util.List>	create(java.lang.String name, java.util.List defaultValue, java.lang.String description)
static PropertyDescriptor<java.util.List>	create(java.lang.String name, java.util.List defaultValue, java.lang.String description, boolean secret)
static PropertyDescriptor<java.lang.String>	create(java.lang.String name, java.lang.String defaultValue, java.lang.String description)
static PropertyDescriptor<java.lang.String>	create(java.lang.String name, java.lang.String defaultValue, java.lang.String description, boolean secret)
protected abstract T	doParse(java.lang.String s) Implements the real parsing, the string argument must nto be null.
boolean	equals(java.lang.Object obj)
java.lang.String	getDefaultDisplayValue()
T	getDefaultValue()
java.lang.String	getDescription()
java.lang.String	getName()
java.lang.Class<T>	getType()
T	parse(java.lang.String s) Parse a string representation of a value and returns the corresponding typed value.
Property<T>	toProperty(java.lang.String s) Parse a string representation of a value and returns the correspondig property value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SECRET_DISPLAY_VALUE

public static final java.lang.String SECRET_DISPLAY_VALUE

The display value returned when a property is secret.

See Also:

Constant Field Values

ALL

public static final java.util.Map<java.lang.String,PropertyDescriptor<?>> ALL

.

VFS_REFRESH_UNIT

public static final PropertyDescriptor<java.util.concurrent.TimeUnit> VFS_REFRESH_UNIT

.

VFS_REFRESH_PERIOD

public static final PropertyDescriptor<java.lang.Integer> VFS_REFRESH_PERIOD

.

type

public final java.lang.Class<T> type

.

name

public final java.lang.String name

.

defaultValue

public final T defaultValue

.

description

public final java.lang.String description

.

secret

public final boolean secret

.

Constructor Detail

PropertyDescriptor

protected PropertyDescriptor(java.lang.Class<T> type,
                  java.lang.String name,
                  T defaultValue,
                  java.lang.String description)
                      throws java.lang.NullPointerException

Create a new property descriptor.

Parameters:

type - the property type

name - the property name

defaultValue - the default value

description - the description

Throws:

java.lang.NullPointerException - if the type, name or description is null

PropertyDescriptor

protected PropertyDescriptor(java.lang.Class<T> type,
                  java.lang.String name,
                  T defaultValue,
                  java.lang.String description,
                  boolean secret)
                      throws java.lang.NullPointerException

Create a new property descriptor.

Parameters:

type - the property type

name - the property name

defaultValue - the default value

description - the description

secret - the value is secret (like a password)

Throws:

java.lang.NullPointerException - if the type, name or description is null

Method Detail

create

public static PropertyDescriptor<java.lang.String> create(java.lang.String name,
                                          java.lang.String defaultValue,
                                          java.lang.String description,
                                          boolean secret)

create

public static PropertyDescriptor<java.lang.String> create(java.lang.String name,
                                          java.lang.String defaultValue,
                                          java.lang.String description)

create

public static PropertyDescriptor<java.lang.Integer> create(java.lang.String name,
                                           java.lang.Integer defaultValue,
                                           java.lang.String description,
                                           boolean secret)

create

public static PropertyDescriptor<java.lang.Integer> create(java.lang.String name,
                                           java.lang.Integer defaultValue,
                                           java.lang.String description)

create

public static PropertyDescriptor<java.util.List> create(java.lang.String name,
                                        java.util.List defaultValue,
                                        java.lang.String description,
                                        boolean secret)

create

public static PropertyDescriptor<java.util.List> create(java.lang.String name,
                                        java.util.List defaultValue,
                                        java.lang.String description)

getName

public final java.lang.String getName()

getDescription

public final java.lang.String getDescription()

getType

public final java.lang.Class<T> getType()

getDefaultValue

public final T getDefaultValue()

getDefaultDisplayValue

public final java.lang.String getDefaultDisplayValue()

parse

public final T parse(java.lang.String s)
              throws java.lang.NullPointerException,
                     java.lang.IllegalArgumentException

Parse a string representation of a value and returns the corresponding typed value.

Parameters:

s - the string to parse

Returns:

the corresponding value

Throws:

java.lang.NullPointerException - if the argument is null

java.lang.IllegalArgumentException - if the string value cannot be parsed for some reason

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toProperty

public final Property<T> toProperty(java.lang.String s)
                             throws java.lang.NullPointerException,
                                    java.lang.IllegalArgumentException

Parse a string representation of a value and returns the correspondig property value.

Parameters:

s - the string to parse

Returns:

the corresponding property

Throws:

java.lang.NullPointerException - if the argument is null

java.lang.IllegalArgumentException - if the string value cannot be parsed for some reason

doParse

protected abstract T doParse(java.lang.String s)
                      throws java.lang.Exception

Implements the real parsing, the string argument must nto be null. The returned value must not be null instead an exception must be thrown.

Parameters:

s - the string to parse

Returns:

the related value

Throws:

java.lang.Exception - any exception that would prevent parsing to hapen

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object