org.docgene.plugins

Interface CustomProperties

public interface CustomProperties

This class hold custom properties which can be used on command-line or the configuration file.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Class<?>>	getPropertiesTypes() Return the Map of properties types.
java.lang.Object	getProperty(java.lang.String key) Return the value of a specified property.
default boolean	hasProperty(java.lang.String key) Return true if a specified property key is handled.
void	reset() Reset the properties.
void	setClassLoader(java.lang.ClassLoader loader) Set the ClassLoader used for the properties.
void	setParser(org.docgene.parser.XMLErrorHandler parser) Set the parent parser which can be notified if an exception is detected while settting the property.
void	setProperty(java.lang.String key, java.lang.Object value) Set the value of a specified property.
void	setup() Setup the class after all the properties have been set.

Method Detail

hasProperty

default boolean hasProperty(java.lang.String key)

Return true if a specified property key is handled.

Parameters:

key - the property key

Returns:

true if the specified property key is handled

getPropertiesTypes

java.util.Map<java.lang.String,java.lang.Class<?>> getPropertiesTypes()

Return the Map of properties types.

Returns:

the Map of properties types

setProperty

void setProperty(java.lang.String key,
                 java.lang.Object value)

Set the value of a specified property.

Parameters:

key - the property key

value - the value

getProperty

java.lang.Object getProperty(java.lang.String key)

Return the value of a specified property.

Parameters:

key - the property key

Returns:

the value

reset

void reset()

Reset the properties.

setup

void setup()

Setup the class after all the properties have been set.

setParser

void setParser(org.docgene.parser.XMLErrorHandler parser)

Set the parent parser which can be notified if an exception is detected while settting the property.

Parameters:

parser - the parent parser

setClassLoader

void setClassLoader(java.lang.ClassLoader loader)

Set the ClassLoader used for the properties.

Parameters:

loader - the ClassLoader used for the properties