org.jtools.props
Interface PropertyRepositoryEntry

All Known Implementing Classes:

SimplePropertyRepository.PropertyEntry

public interface PropertyRepositoryEntry

Nested Class Summary

static class

PropertyRepositoryEntry.ItemType

Method Summary

boolean	addTargetAsSuffix() indicates whether a target should added as suffix.
PropertyRepositoryEntry	createDirSubEntry(String key, String Directory, String BaseFile, String MainEntry, String Prefix, String ListProperty, String concatListProperty, boolean addTargetAsSuffix)
PropertyRepositoryEntry	createFileSubEntry(String key, String Directory, String BaseFile, String Prefix, String ListProperty, String concatListProperty, boolean addTargetAsSuffix)
String	getBaseFilename() returns the filename (without extension) of a basefile
String	getConcatListProperty() indicates whether an property with the generated suffix has to be concatenated with the list property.
String	getEntryKey() returns the key of this entry
PropertyRepositoryEntry.ItemType	getItemType() indicates whether the items are files or subdirectories.
String	getKeyPrefix() returns the property prefix of this entries properties. if this is an static entry it will be taken 1-to-1. if this entry is dynamic, this prefix will be added to the parents entry.
String	getListProperty() returns the property prefix of this entries properties. if this is an static entry it will be taken 1-to-1. if this entry is dynamic, this prefix will be added to the parents entry.
String	getMainEntryFilename() returns the name of the main property file in the directory.
PropertyRepositoryEntry	getParentEntry() returns the parent entry.
String	getStaticDirectoryName() returns the static directory. if Parent is not null, the directory is relative to the parents directoyr
boolean	isDynamic() indicates whether the directory name is dynamic or static.
int	read(PropertySupport dest, File repositoryRoot, String Extension, String... targets)

Method Detail

createFileSubEntry

PropertyRepositoryEntry createFileSubEntry(String key,
                                           String Directory,
                                           String BaseFile,
                                           String Prefix,
                                           String ListProperty,
                                           String concatListProperty,
                                           boolean addTargetAsSuffix)

createDirSubEntry

PropertyRepositoryEntry createDirSubEntry(String key,
                                          String Directory,
                                          String BaseFile,
                                          String MainEntry,
                                          String Prefix,
                                          String ListProperty,
                                          String concatListProperty,
                                          boolean addTargetAsSuffix)

getEntryKey

String getEntryKey()

returns the key of this entry

getItemType

PropertyRepositoryEntry.ItemType getItemType()

indicates whether the items are files or subdirectories.

isDynamic

boolean isDynamic()

indicates whether the directory name is dynamic or static.

getParentEntry

PropertyRepositoryEntry getParentEntry()

returns the parent entry.

getBaseFilename

String getBaseFilename()

returns the filename (without extension) of a basefile

getKeyPrefix

String getKeyPrefix()

returns the property prefix of this entries properties. if this is an static entry it will be taken 1-to-1. if this entry is dynamic, this prefix will be added to the parents entry.

getListProperty

String getListProperty()

returns the property prefix of this entries properties. if this is an static entry it will be taken 1-to-1. if this entry is dynamic, this prefix will be added to the parents entry.

getConcatListProperty

String getConcatListProperty()

indicates whether an property with the generated suffix has to be concatenated with the list property.

addTargetAsSuffix

boolean addTargetAsSuffix()

indicates whether a target should added as suffix.

read

int read(PropertySupport dest,
         File repositoryRoot,
         String Extension,
         String... targets)
         throws IOException

Throws:

IOException

getMainEntryFilename

String getMainEntryFilename()

returns the name of the main property file in the directory.

getStaticDirectoryName

String getStaticDirectoryName()

returns the static directory. if Parent is not null, the directory is relative to the parents directoyr