Package org.openbase.jps.core

Class AbstractJavaProperty<V>

java.lang.Object

org.openbase.jps.core.AbstractJavaProperty<V>

Type Parameters:

V -

All Implemented Interfaces:

Comparable<AbstractJavaProperty>

Direct Known Subclasses:

AbstractJPBoolean, AbstractJPClass, AbstractJPDouble, AbstractJPEnum, AbstractJPFile, AbstractJPFloat, AbstractJPInteger, AbstractJPList, AbstractJPLong, AbstractJPMap, AbstractJPMethod, AbstractJPString, AbstractJPTime, JPHelp, JPLocale

public abstract class AbstractJavaProperty<V>
extends Object
implements Comparable<AbstractJavaProperty>

Author:

Divine Threepwood

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AbstractJavaProperty.ValueType

Field Summary

Fields

Modifier and Type	Field	Description
protected final String[]	argumentIdentifiers
protected final List<String>	arguments
protected String	identifier
protected final org.slf4j.Logger	logger
protected final String[]	propertyIdentifiers

Constructor Summary

Constructors

Constructor	Description
AbstractJavaProperty(String[] propertyIdentifier)

Method Summary

Modifier and Type	Method	Description
protected final void	addArgument(String arg)
protected final void	addErrorReport(Exception exception, AbstractJavaProperty.ValueType valueType)
protected final void	checkArgumentCount(int size)
protected final void	checkArgumentCount(int min, int max)
protected final void	checkArgumentCountMax(int max)
protected final void	checkArgumentCountMin(int min)
final int	compareTo(AbstractJavaProperty o)
protected abstract String[]	generateArgumentIdentifiers()
protected final String[]	getArgumentIdentifiers()
String	getDefaultExample()
final V	getDefaultValue()
final List<Class<? extends AbstractJavaProperty<?>>>	getDependencyList()	Method returns a list with properties where this property depends on.
abstract String	getDescription()	Method returns the description of the property.
protected final Exception	getErrorReport()
protected final Map<AbstractJavaProperty.ValueType,Exception>	getErrorReportMap()
protected final String	getOneArgumentResult()
protected abstract V	getPropertyDefaultValue()
protected final String[]	getPropertyIdentifiers()
String	getSyntax()
final V	getValue()
final AbstractJavaProperty.ValueType	getValueType()
protected final boolean	isIdentified()
protected boolean	isIdentifiered()	Deprecated. please use isIdentified() instead
final boolean	isParsed()
protected void	loadAction()	Can be overwritten for specific load action.
protected final boolean	match(String commandIdentifier)
protected final boolean	neetToBeParsed()
protected final void	overwriteDefaultValue(V defaultValue)
protected abstract V	parse(List<String> arguments)
protected final void	parseArguments()
protected final void	registerDependingProperty(Class<? extends AbstractJavaProperty<?>> dependency)
protected final void	reset()
protected void	setValue(V value, AbstractJavaProperty.ValueType valueType)
String	toString()
final void	update(V value)
protected final void	updateValue()
protected void	validate()	Can be overwritten for value validation.

Methods inherited from class java.lang.Object

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

Field Details

logger

protected final org.slf4j.Logger logger

propertyIdentifiers

protected final String[] propertyIdentifiers

argumentIdentifiers

protected final String[] argumentIdentifiers

arguments

protected final List<String> arguments

identifier

protected String identifier

Constructor Details

AbstractJavaProperty

public AbstractJavaProperty(String[] propertyIdentifier)

Method Details

match

protected final boolean match(String commandIdentifier)

neetToBeParsed

protected final boolean neetToBeParsed()

reset

protected final void reset()

addArgument

protected final void addArgument(String arg)

parseArguments

protected final void parseArguments()
                             throws JPParsingException

Throws:

JPParsingException

getValue

public final V getValue()

setValue

protected void setValue(V value,
 AbstractJavaProperty.ValueType valueType)

update

public final void update(V value)

updateValue

protected final void updateValue()
                          throws JPServiceException

Throws:

JPServiceException

overwriteDefaultValue

protected final void overwriteDefaultValue(V defaultValue)

toString

public String toString()

Overrides:

toString in class Object

isIdentifiered

@Deprecated
protected boolean isIdentifiered()

Deprecated.

please use isIdentified() instead

isIdentified

protected final boolean isIdentified()

getDefaultValue

public final V getDefaultValue()
                        throws JPNotAvailableException

Throws:

JPNotAvailableException

generateArgumentIdentifiers

protected abstract String[] generateArgumentIdentifiers()

getPropertyIdentifiers

protected final String[] getPropertyIdentifiers()

getArgumentIdentifiers

protected final String[] getArgumentIdentifiers()

getDefaultExample

public String getDefaultExample()

getSyntax

public String getSyntax()

isParsed

public final boolean isParsed()

compareTo

public final int compareTo(AbstractJavaProperty o)

Specified by:

compareTo in interface Comparable<V>

getOneArgumentResult

protected final String getOneArgumentResult()
                                     throws JPBadArgumentException

Throws:

JPBadArgumentException

getValueType

public final AbstractJavaProperty.ValueType getValueType()

checkArgumentCount

protected final void checkArgumentCount(int size)
                                 throws JPBadArgumentException

Throws:

JPBadArgumentException

checkArgumentCountMin

protected final void checkArgumentCountMin(int min)
                                    throws JPBadArgumentException

Throws:

JPBadArgumentException

checkArgumentCountMax

protected final void checkArgumentCountMax(int max)
                                    throws JPBadArgumentException

Throws:

JPBadArgumentException

checkArgumentCount

protected final void checkArgumentCount(int min,
 int max)
                                 throws JPBadArgumentException

Throws:

JPBadArgumentException

addErrorReport

protected final void addErrorReport(Exception exception,
 AbstractJavaProperty.ValueType valueType)

getErrorReport

protected final Exception getErrorReport()

getErrorReportMap

protected final Map<AbstractJavaProperty.ValueType,Exception> getErrorReportMap()

validate

protected void validate()
                 throws JPValidationException

Can be overwritten for value validation. Method is called after parsing.

Throws:

JPValidationException

loadAction

protected void loadAction()

Can be overwritten for specific load action. Method is called after loading a property instance.

getPropertyDefaultValue

protected abstract V getPropertyDefaultValue()
                                      throws JPNotAvailableException

Throws:

JPNotAvailableException

parse

protected abstract V parse(List<String> arguments)
                    throws Exception

Throws:

Exception

getDependencyList

public final List<Class<? extends AbstractJavaProperty<?>>> getDependencyList()

Method returns a list with properties where this property depends on.

Returns:

a list of java properties.

registerDependingProperty

protected final void registerDependingProperty(Class<? extends AbstractJavaProperty<?>> dependency)

getDescription

public abstract String getDescription()

Method returns the description of the property.