com.ca.jcs.converter.meta
Class ConverterConfig

java.lang.Object
  com.ca.jcs.converter.meta.ConverterConfig

Direct Known Subclasses:

BoolPropertyConverter.BoolConfig, CountryPropertyConverter.CountryCodeConfig, DemoFlattenPropertyConverter.DemoFlattenConfig, EncyptPropertyConverter.EncryptConfig, EnumPropertyConverter.EnumConfig, JavaObjectPropertyConverter.Config, JSONCompoundValueClassConverter.Config, MultiValuePropertyFlattener.StyleConfig, NullValueClassConverter.NullValueConverterConfig, RegexPropertyConverter.Config

public class ConverterConfig
extends Object

Default setting for converters that need specialised configuration via the server_jcs.xml or impl bundle Spring configuration files.

Field Summary

static int	DEFAULT_ORDER
static int	STRUCTURAL_ORDER

Constructor Summary

ConverterConfig()
Create config with boolean values defaulting to false and order defaulting to DEFAULT_ORDER.

Method Summary

int	getOrder()
static int	getOrder(ConverterConfig convCfg)
boolean	isActiveByDefault()
boolean	isExclusive()
void	setActiveByDefault(boolean activeByDefault)
void	setExclusive(boolean exclusive) Allows a plug-in to assert it should be the only applicable one in a particular case, in which case all other plug-ins will be ignored regardless of their order value.
void	setOrder(int order) This field allows a sort order to be specified between competing non-exclusive plugins which apply to a single case, where values are sorted in ascending value.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ORDER

public static final int DEFAULT_ORDER

See Also:

Constant Field Values

STRUCTURAL_ORDER

public static final int STRUCTURAL_ORDER

See Also:

Constant Field Values

Constructor Detail

ConverterConfig

public ConverterConfig()

Create config with boolean values defaulting to false and order defaulting to DEFAULT_ORDER.

Method Detail

isExclusive

public boolean isExclusive()

setExclusive

public void setExclusive(boolean exclusive)

Allows a plug-in to assert it should be the only applicable one in a particular case, in which case all other plug-ins will be ignored regardless of their order value.

Parameters:

exclusive - Set to true to ensure other plug-ins will be ignored if the plug-in associated with this configuration doesn't veto it's construction by throwing a plugin not required exception.

getOrder

public int getOrder()

setOrder

public void setOrder(int order)

This field allows a sort order to be specified between competing non-exclusive plugins which apply to a single case, where values are sorted in ascending value.

Parameters:

order - Relative order of this plug-in, where values need not be continuous and the order of plugins with the same value is undefined.

isActiveByDefault

public boolean isActiveByDefault()

setActiveByDefault

public void setActiveByDefault(boolean activeByDefault)

getOrder

public static int getOrder(ConverterConfig convCfg)