de.mhus.lib.core.directory.fs

Class FileResource

java.lang.Object

de.mhus.lib.core.MLog

de.mhus.lib.core.lang.MObject

de.mhus.lib.core.IProperties

de.mhus.lib.core.directory.ResourceNode

de.mhus.lib.core.directory.fs.FileResource

All Implemented Interfaces:

ILog, Serializable, Iterable<Map.Entry<String,Object>>

Direct Known Subclasses:

FileResourceRoot

public class FileResource
extends ResourceNode

FileResource class.

Version:

$Id: $Id

Author:

mikehummel

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileResource.KEYS
static class	FileResource.TYPE

Field Summary

Fields

Modifier and Type	Field and Description
static long	UNKNOWN_LENGTH Constant UNKNOWN_LENGTH=-1

Fields inherited from class de.mhus.lib.core.directory.ResourceNode

compiledCache, compiler

Constructor Summary

Constructors

Constructor and Description
FileResource(FileResourceRoot root, FileResource parent, File file) Constructor for FileResource.

Method Summary

Modifier and Type	Method and Description
InputStream	getInputStream(String key) Return the input stream of a content resource.
String	getName() Return a name of this config element could also be null.
ResourceNode	getNode(String key) Returns a inner configuration by the name.
String[]	getNodeKeys() Return all possible, existing inner configuration names.
ResourceNode[]	getNodes() Return all inner configurations ignoring the name.
ResourceNode[]	getNodes(String key) Return all inner configurations by the given name.
ResourceNode	getParent() return the parent config if possible.
Object	getProperty(String name) Overwrite this function to provide values in string format.
String[]	getPropertyKeys() Return all existing keys.
URL	getUrl() getUrl.
boolean	hasContent() hasContent.
boolean	isEditable() Overwrite this function and return true if the property set can be edited.
boolean	isProperty(String name) Return true if the property exists.
boolean	isValide() isValide.
void	removeProperty(String key) Remove the property field in the list of properties.
void	setProperty(String key, Object value) Overwrite this function to allow changes in properties.

Methods inherited from class de.mhus.lib.core.directory.ResourceNode

getExtracted, getExtracted, getExtracted, getInputStream, getNodeByPath, keys

Methods inherited from class de.mhus.lib.core.IProperties

getBoolean, getBoolean, getCalendar, getDate, getDouble, getFloat, getInt, getLong, getNumber, getProperty, getString, getString, iterator, setBoolean, setCalendar, setDate, setDouble, setFloat, setInt, setLong, setNumber, setString, toMap

Methods inherited from class de.mhus.lib.core.lang.MObject

base, base, createBase, forkBase, installBase, isBase, leaveBase, toString

Methods inherited from class de.mhus.lib.core.MLog

log

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

UNKNOWN_LENGTH

public static final long UNKNOWN_LENGTH

Constant UNKNOWN_LENGTH=-1

See Also:

Constant Field Values

Constructor Detail

FileResource

public FileResource(FileResourceRoot root,
                    FileResource parent,
                    File file)

Constructor for FileResource.

Parameters:

root - a FileResourceRoot object.

parent - a FileResource object.

file - a File object.

Method Detail

getPropertyKeys

public String[] getPropertyKeys()

Return all existing keys. A property key is unique.

Specified by:

getPropertyKeys in class ResourceNode

Returns:

an array of String objects.

getNode

public ResourceNode getNode(String key)

Returns a inner configuration by the name. Inner configurations are not unique. If more then one configurations exists it will return the first one. if no configuration exists it returns null.

Specified by:

getNode in class ResourceNode

Parameters:

key - a String object.

Returns:

a ResourceNode object.

getNodes

public ResourceNode[] getNodes()

Return all inner configurations ignoring the name. The order is like in the configuration file. This never returns null.

Specified by:

getNodes in class ResourceNode

Returns:

an array of ResourceNode objects.

getNodes

public ResourceNode[] getNodes(String key)

Return all inner configurations by the given name. The order is like in the configuration file. This never returns null.

Specified by:

getNodes in class ResourceNode

Parameters:

key - a String object.

Returns:

an array of ResourceNode objects.

getNodeKeys

public String[] getNodeKeys()

Return all possible, existing inner configuration names.

Specified by:

getNodeKeys in class ResourceNode

Returns:

an array of String objects.

getName

public String getName()
               throws MException

Return a name of this config element could also be null. The name most time is the name of a sub config.

Specified by:

getName in class ResourceNode

Returns:

a String object.

Throws:

MException - if any.

getInputStream

public InputStream getInputStream(String key)

Return the input stream of a content resource.

Specified by:

getInputStream in class ResourceNode

Parameters:

key - Name of a rendition or null for the default content

Returns:

a InputStream object.

getParent

public ResourceNode getParent()

return the parent config if possible.

Specified by:

getParent in class ResourceNode

Returns:

a ResourceNode object.

getUrl

public URL getUrl()

getUrl.

Specified by:

getUrl in class ResourceNode

Returns:

a URL object.

getProperty

public Object getProperty(String name)

Overwrite this function to provide values in string format.

Specified by:

getProperty in class IProperties

Parameters:

name - a String object.

Returns:

null if the property not exists or the property value.

isProperty

public boolean isProperty(String name)

Return true if the property exists.

Specified by:

isProperty in class IProperties

Parameters:

name - a String object.

Returns:

a boolean.

removeProperty

public void removeProperty(String key)

Remove the property field in the list of properties.

Specified by:

removeProperty in class IProperties

Parameters:

key - a String object.

setProperty

public void setProperty(String key,
                        Object value)

Overwrite this function to allow changes in properties.

Specified by:

setProperty in class IProperties

Parameters:

key - a String object.

value - a Object object.

isEditable

public boolean isEditable()

Overwrite this function and return true if the property set can be edited.

Specified by:

isEditable in class IProperties

Returns:

a boolean.

isValide

public boolean isValide()

isValide.

Specified by:

isValide in class ResourceNode

Returns:

a boolean.

hasContent

public boolean hasContent()

hasContent.

Specified by:

hasContent in class ResourceNode

Returns:

a boolean.