Package org.openbase.jps.preset

Class AbstractJPFile

java.lang.Object

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

org.openbase.jps.preset.AbstractJPFile

All Implemented Interfaces:

Comparable<AbstractJavaProperty>

Direct Known Subclasses:

AbstractJPDirectory, JPPropertyFile

public abstract class AbstractJPFile
extends AbstractJavaProperty<File>

Author:

Divine Threepwood

Nested Class Summary

Nested classes/interfaces inherited from class org.openbase.jps.core.AbstractJavaProperty

AbstractJavaProperty.ValueType

Field Summary

Fields inherited from class org.openbase.jps.core.AbstractJavaProperty

argumentIdentifiers, arguments, identifier, logger, propertyIdentifiers

Constructor Summary

Constructors

Constructor	Description
AbstractJPFile(String[] commandIdentifier, FileHandler.ExistenceHandling existenceHandling, FileHandler.AutoMode autoCreateMode)

Method Summary

Modifier and Type	Method	Description
static String	convertIntoValidFileName(String filename)
protected String[]	generateArgumentIdentifiers()
FileHandler.AutoMode	getAutoCreateMode()
FileHandler.ExistenceHandling	getExistenceHandling()
File	getParentDirectory()
FileHandler.FileType	getType()
protected File	parse(List<String> arguments)
protected void	setAutoCreateMode(FileHandler.AutoMode autoCreateMode)
protected void	setExistenceHandling(FileHandler.ExistenceHandling existenceHandling)
protected void	setValue(File value, AbstractJavaProperty.ValueType valueType)
String	toString()
void	validate()	Can be overwritten for value validation.

Methods inherited from class org.openbase.jps.core.AbstractJavaProperty

addArgument, addErrorReport, checkArgumentCount, checkArgumentCount, checkArgumentCountMax, checkArgumentCountMin, compareTo, getArgumentIdentifiers, getDefaultExample, getDefaultValue, getDependencyList, getDescription, getErrorReport, getErrorReportMap, getOneArgumentResult, getPropertyDefaultValue, getPropertyIdentifiers, getSyntax, getValue, getValueType, isIdentified, isIdentifiered, isParsed, loadAction, match, neetToBeParsed, overwriteDefaultValue, parseArguments, registerDependingProperty, reset, update, updateValue

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractJPFile

public AbstractJPFile(String[] commandIdentifier,
 FileHandler.ExistenceHandling existenceHandling,
 FileHandler.AutoMode autoCreateMode)

Method Details

convertIntoValidFileName

public static String convertIntoValidFileName(String filename)

generateArgumentIdentifiers

protected String[] generateArgumentIdentifiers()

Specified by:

generateArgumentIdentifiers in class AbstractJavaProperty<File>

parse

protected File parse(List<String> arguments)
              throws Exception

Specified by:

parse in class AbstractJavaProperty<File>

Throws:

Exception

validate

public void validate()
              throws JPValidationException

Description copied from class: AbstractJavaProperty

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

Overrides:

validate in class AbstractJavaProperty<File>

Throws:

JPValidationException

setValue

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

Overrides:

setValue in class AbstractJavaProperty<File>

getAutoCreateMode

public FileHandler.AutoMode getAutoCreateMode()

setAutoCreateMode

protected void setAutoCreateMode(FileHandler.AutoMode autoCreateMode)

getExistenceHandling

public FileHandler.ExistenceHandling getExistenceHandling()

setExistenceHandling

protected void setExistenceHandling(FileHandler.ExistenceHandling existenceHandling)

getType

public FileHandler.FileType getType()

getParentDirectory

public File getParentDirectory()
                        throws JPServiceException

Returns:

the parent dir or null if the no parent exist. Method can be overwritten to defining the parent dir.

Throws:

JPServiceException - in case the parent directory is not available.

toString

public String toString()

Overrides:

toString in class AbstractJavaProperty<File>