Package org.fugerit.java.doc.base.facade

Class DocHandlerFactory

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,DocHandlerFacade>

org.fugerit.java.doc.base.facade.DocHandlerFactory

All Implemented Interfaces:

Serializable, Cloneable, Map<String,DocHandlerFacade>

public class DocHandlerFactory
extends HashMap<String,DocHandlerFacade>

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

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 final String	USE_CATALOG_PROP

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getUseCatalog()
int	hashCode()
static DocHandlerFactory	newInstance(InputStream factoryConfig)	Creates and configure an instance of DocHandlerFactory
static DocHandlerFactory	newInstance(String factoryCatalogPath)	Creates and configure an instance of DocHandlerFactory
static DocHandlerFactory	newInstance(org.fugerit.java.core.cfg.xml.FactoryCatalog catalog)	Creates and configure an instance of DocHandlerFactory
static DocHandlerFacade	register(String factoryCatalogPath)	Creates and configure an instance of DocHandlerFacade with default catalog id.
static DocHandlerFacade	register(String factoryCatalogPath, String useCatalog)	Creates and configure an instance of DocHandlerFacade
static DocHandlerFacade	register(Collection<org.fugerit.java.core.cfg.xml.FactoryType> col)	Creates and configure an instance of DocHandlerFacade
static DocHandlerFacade	register(org.fugerit.java.core.cfg.xml.FactoryCatalog catalog)	Creates and configure an instance of DocHandlerFacade with default catalog id.
static DocHandlerFacade	register(org.fugerit.java.core.cfg.xml.FactoryCatalog catalog, String useCatalog)	Creates and configure an instance of DocHandlerFacade

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

USE_CATALOG_PROP

public static final String USE_CATALOG_PROP

See Also:

• Constant Field Values

Method Details

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,DocHandlerFacade>

Overrides:

hashCode in class AbstractMap<String,DocHandlerFacade>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<String,DocHandlerFacade>

Overrides:

equals in class AbstractMap<String,DocHandlerFacade>

register

public static DocHandlerFacade register(String factoryCatalogPath)

Creates and configure an instance of DocHandlerFacade with default catalog id.

NOTE: starting from version 8.4.X java.lang.Exception removed in favor of org.fugerit.java.core.cfg.ConfigRuntimeException.

Parameters:

factoryCatalogPath - the factory catalog xml path

Returns:

the configured facade

See Also:

• Define and throw a dedicated exception instead of using a generic one.

register

public static DocHandlerFacade register(String factoryCatalogPath,
 String useCatalog)

Creates and configure an instance of DocHandlerFacade

NOTE: starting from version 8.4.X java.lang.Exception removed in favor of org.fugerit.java.core.cfg.ConfigRuntimeException.

Parameters:

factoryCatalogPath - the factory catalog xml path

useCatalog - the catalog id to use

Returns:

the configured facade

See Also:

• Define and throw a dedicated exception instead of using a generic one.

register

public static DocHandlerFacade register(Collection<org.fugerit.java.core.cfg.xml.FactoryType> col)

Creates and configure an instance of DocHandlerFacade

NOTE: starting from version 8.4.X java.lang.Exception removed in favor of org.fugerit.java.core.cfg.ConfigRuntimeException.

Parameters:

col - the collection of factory type

Returns:

the configured facade

See Also:

• Define and throw a dedicated exception instead of using a generic one.

register

public static DocHandlerFacade register(org.fugerit.java.core.cfg.xml.FactoryCatalog catalog)

Creates and configure an instance of DocHandlerFacade with default catalog id.

NOTE: starting from version 8.4.X java.lang.Exception removed in favor of org.fugerit.java.core.cfg.ConfigRuntimeException.

Parameters:

catalog - the factory catalog

Returns:

the doc handler facade

See Also:

• Define and throw a dedicated exception instead of using a generic one.

register

public static DocHandlerFacade register(org.fugerit.java.core.cfg.xml.FactoryCatalog catalog,
 String useCatalog)

Creates and configure an instance of DocHandlerFacade

NOTE: starting from version 8.4.X java.lang.Exception removed in favor of org.fugerit.java.core.cfg.ConfigRuntimeException.

Parameters:

catalog - the factory catalog

useCatalog - the catalog id to use to create the facade

Returns:

the doc handler facade

See Also:

• Define and throw a dedicated exception instead of using a generic one.

newInstance

public static DocHandlerFactory newInstance(InputStream factoryConfig)

Creates and configure an instance of DocHandlerFactory

NOTE: starting from version 8.4.X java.lang.Exception removed in favor of org.fugerit.java.core.cfg.ConfigRuntimeException.

Parameters:

factoryConfig - a stream on xml configuration document

Returns:

the configured DocHandlerFactory

Throws:

org.fugerit.java.core.cfg.ConfigRuntimeException - in case of issues during loading

See Also:

• Define and throw a dedicated exception instead of using a generic one.

newInstance

public static DocHandlerFactory newInstance(String factoryCatalogPath)

Creates and configure an instance of DocHandlerFactory

NOTE: starting from version 8.4.X java.lang.Exception removed in favor of org.fugerit.java.core.cfg.ConfigRuntimeException.

Parameters:

factoryCatalogPath - the path to the factory catalog xml

Returns:

the configured DocHandlerFactory

Throws:

org.fugerit.java.core.cfg.ConfigRuntimeException - in case of issues during loading

See Also:

• Define and throw a dedicated exception instead of using a generic one.

newInstance

public static DocHandlerFactory newInstance(org.fugerit.java.core.cfg.xml.FactoryCatalog catalog)

Creates and configure an instance of DocHandlerFactory

NOTE: starting from version 8.4.X java.lang.Exception removed in favor of org.fugerit.java.core.cfg.ConfigRuntimeException.

Parameters:

catalog - the factory catalog to use

Returns:

the configured factory

See Also:

• Define and throw a dedicated exception instead of using a generic one.

getUseCatalog

public String getUseCatalog()