Package 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.AbstractProperties

de.mhus.lib.core.directory.ResourceNode<FileResource>

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

All Implemented Interfaces:

ILog, IProperties, IReadProperties, MNlsProvider, Nls, Serializable, Iterable<Map.Entry<String,Object>>, Map<String,Object>

Direct Known Subclasses:

FileResourceRoot

public class FileResource
extends ResourceNode<FileResource>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static long	UNKNOWN_LENGTH

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

compiledCache, compiler

Constructor Summary

Constructors

Constructor	Description
FileResource(FileResourceRoot root, FileResource parent, File file)

Method Summary

Modifier and Type	Method	Description
void	clear()
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.
FileResource	getNode(String key)	Returns a inner configuration by the name.
Collection<String>	getNodeKeys()	Return all possible, existing inner configuration names.
Collection<FileResource>	getNodes()	Return all inner configurations ignoring the name.
Collection<FileResource>	getNodes(String key)	Return all inner configurations by the given name.
FileResource	getParent()	return the parent config if possible.
Object	getProperty(String name)	Overwrite this function to provide values in string format.
Collection<String>	getPropertyKeys()	Return all existing keys.
IProperties	getRenditionProperties(String rendition)	Returns a set of properties to define the rendition.
Collection<String>	getRenditions()	Returns a list of available renditions.
URL	getUrl()
boolean	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	isValid()
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

containsValue, dump, entrySet, getExtracted, getExtracted, getExtracted, getInputStream, getNodeByPath, getRenditionProperties, keys, size, values

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

containsKey, get, getBoolean, getBoolean, getCalendar, getDate, getDouble, getFloat, getFormatted, getInt, getLong, getNumber, getString, getString, isEmpty, iterator, keySet, put, putAll, putReadProperties, remove, setBoolean, setCalendar, setDate, setDouble, setFloat, setInt, setLong, setNumber, setString, toMap

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

getNls, nls, 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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

UNKNOWN_LENGTH

public static final long UNKNOWN_LENGTH

See Also:

Constant Field Values

Constructor Detail

FileResource

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

Method Detail

getPropertyKeys

public Collection<String> getPropertyKeys()

Description copied from class: ResourceNode

Return all existing keys. A property key is unique.

Specified by:

getPropertyKeys in class ResourceNode<FileResource>

Returns:

all keys

getNode

public FileResource getNode(String key)

Description copied from class: ResourceNode

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<FileResource>

Returns:

the node with the name

getNodes

public Collection<FileResource> getNodes()

Description copied from class: ResourceNode

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<FileResource>

Returns:

all nodes

getNodes

public Collection<FileResource> getNodes(String key)

Description copied from class: ResourceNode

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<FileResource>

Returns:

all nodes with the name

getNodeKeys

public Collection<String> getNodeKeys()

Description copied from class: ResourceNode

Return all possible, existing inner configuration names.

Specified by:

getNodeKeys in class ResourceNode<FileResource>

Returns:

keys from nodes

getName

public String getName()
               throws de.mhus.lib.errors.MException

Description copied from class: ResourceNode

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<FileResource>

Returns:

node of this node

Throws:

de.mhus.lib.errors.MException

getInputStream

public InputStream getInputStream(String key)

Description copied from class: ResourceNode

Return the input stream of a content resource.

Specified by:

getInputStream in class ResourceNode<FileResource>

Parameters:

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

Returns:

input stream

getParent

public FileResource getParent()

Description copied from class: ResourceNode

return the parent config if possible.

Specified by:

getParent in class ResourceNode<FileResource>

Returns:

parent node

getUrl

public URL getUrl()

Specified by:

getUrl in class ResourceNode<FileResource>

getProperty

public Object getProperty(String name)

Description copied from class: AbstractProperties

Overwrite this function to provide values in string format.

Specified by:

getProperty in interface IReadProperties

Specified by:

getProperty in class AbstractProperties

Returns:

null if the property not exists or the property value.

isProperty

public boolean isProperty(String name)

Description copied from class: AbstractProperties

Return true if the property exists.

Specified by:

isProperty in interface IReadProperties

Specified by:

isProperty in class AbstractProperties

Returns:

if exists

removeProperty

public void removeProperty(String key)

Description copied from class: AbstractProperties

Remove the property field in the list of properties.

Specified by:

removeProperty in interface IProperties

Specified by:

removeProperty in class AbstractProperties

setProperty

public void setProperty(String key,
                        Object value)

Description copied from class: AbstractProperties

Overwrite this function to allow changes in properties.

Specified by:

setProperty in class AbstractProperties

isEditable

public boolean isEditable()

Description copied from class: AbstractProperties

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

Specified by:

isEditable in interface IProperties

Specified by:

isEditable in class AbstractProperties

Returns:

if is editable

isValid

public boolean isValid()

Specified by:

isValid in class ResourceNode<FileResource>

hasContent

public boolean hasContent()

Specified by:

hasContent in class ResourceNode<FileResource>

getRenditions

public Collection<String> getRenditions()

Description copied from class: ResourceNode

Returns a list of available renditions. Will not return the default rendition.

Specified by:

getRenditions in class ResourceNode<FileResource>

Returns:

The list or null if hasContent() is false

clear

public void clear()

getRenditionProperties

public IProperties getRenditionProperties(String rendition)

Description copied from class: ResourceNode

Returns a set of properties to define the rendition.

Specified by:

getRenditionProperties in class ResourceNode<FileResource>

Returns:

properties