Package com.zfabrik.components.provider.util

Class AbstractComponentDescriptor

java.lang.Object

com.zfabrik.components.provider.util.AbstractComponentDescriptor

All Implemented Interfaces:

IComponentDescriptor, Serializable

Direct Known Subclasses:

FSCRDBComponent

public abstract class AbstractComponentDescriptor
extends Object
implements IComponentDescriptor, Serializable

Abstract implementation of a component descriptor. Useful in component repository implementations This implementation supports the switch board development mode feature. That is, in development mode, component properties may be overwritten by system properties following the naming scheme:

< component name >/ < property name > = < new value >

This implementation furthermore supports processing of properties for IComponentDescriptorProcessor implementations, such as the built-in JEXL3 support.

See Also:

• Serialized Form

Field Summary

Fields inherited from interface com.zfabrik.components.IComponentDescriptor

ANY_COMPONENT_TYPE, COMPONENT_ALIAS, COMPONENT_CLZ, COMPONENT_DESCRIPTOR_STYLE_PLAIN, COMPONENT_NAME, COMPONENT_TYPE, DEPENDENCIES, EXTENSION_POINTS, LINK_COMPONENT_TYPE, LINK_TARGET_COMPONENT, REVISION_INFO

Constructor Summary

Constructors

Constructor	Description
AbstractComponentDescriptor()	Default constructor
AbstractComponentDescriptor(AbstractComponentDescriptor a)	Copy constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getName()	Gets the name of the component.
Properties	getProperties()	Get the properties of this component.
String	getProperty(String name)	Just a short hand for getProperties().getProperty(String)
Properties	getRawProperties()	Get the raw properties of this component.
long	getRevision()	Get the revision of the component.
String	getType()	Gets the type of the component.
int	hashCode()
static Properties	processProperties(Properties raw)	This method uses the to process properties to their target representation using none or some resolvable expression processing facility.
static Properties	processProperties(Properties raw, Function<String,IComponentDescriptorProcessor> getProcessor)	Processing with custom retrieval of processors.
void	setName(String name)
void	setProperties(Properties properties)
void	setRevision(long revision)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AbstractComponentDescriptor

public AbstractComponentDescriptor()

Default constructor

AbstractComponentDescriptor

public AbstractComponentDescriptor(AbstractComponentDescriptor a)

Copy constructor

Method Details

setProperties

public void setProperties(Properties properties)

getRawProperties

public Properties getRawProperties()

Description copied from interface: IComponentDescriptor

Get the raw properties of this component. Note that unlike IComponentDescriptor.getProperties() the result of this method is data as defined in persistent component configuration-

Specified by:

getRawProperties in interface IComponentDescriptor

setName

public void setName(String name)

setRevision

public void setRevision(long revision)

getName

public String getName()

Description copied from interface: IComponentDescriptor

Gets the name of the component.

Specified by:

getName in interface IComponentDescriptor

getProperties

public Properties getProperties()

Description copied from interface: IComponentDescriptor

Get the properties of this component. Note that these differ from the original configuration in these may be processed by some expression language evaluator.

Specified by:

getProperties in interface IComponentDescriptor

processProperties

public static Properties processProperties(Properties raw)

This method uses the to process properties to their target representation using none or some resolvable expression processing facility.

processProperties

public static Properties processProperties(Properties raw,
 Function<String,IComponentDescriptorProcessor> getProcessor)

Processing with custom retrieval of processors. See also IComponentDescriptor.

getRevision

public long getRevision()

Description copied from interface: IComponentDescriptor

Get the revision of the component. Minimum revision is zero. Revisions may not necessarily be strictly increasing, as components may be provided by different repositories over time.

Specified by:

getRevision in interface IComponentDescriptor

getType

public String getType()

Description copied from interface: IComponentDescriptor

Gets the type of the component. A short-hand for getProperty(COMPONENT_TYPE).

Specified by:

getType in interface IComponentDescriptor

getProperty

public String getProperty(String name)

Description copied from interface: IComponentDescriptor

Just a short hand for getProperties().getProperty(String)

Specified by:

getProperty in interface IComponentDescriptor

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object