Package org.opencms.ade.configuration

Class CmsADEConfigDataInternal.ConfigReferenceMeta

java.lang.Object

org.opencms.ade.configuration.CmsADEConfigDataInternal.ConfigReferenceMeta

Enclosing class:

CmsADEConfigDataInternal

public static class CmsADEConfigDataInternal.ConfigReferenceMeta
extends java.lang.Object

Represents additional metadata from the query string of a master configuration link.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PARAM_TEMPLATE	The 'template' parameter.

Constructor Summary

Constructors

Constructor	Description
ConfigReferenceMeta()	Creates a new, empty instance.
ConfigReferenceMeta(java.util.Map<java.lang.String,java.lang.String[]> params)	Creates a new instance from the parameters from a master configuration link.

Method Summary

Modifier and Type	Method	Description
CmsADEConfigDataInternal.ConfigReferenceMeta	combine(CmsADEConfigDataInternal.ConfigReferenceMeta next)	If this object is the metadata for a link to a master configuration M, and 'next' is the metadata for a link from M to some other master configuration N, combines the metadata into a single object and returns it.
java.lang.String	getTemplate()	Gets the template identifier.
boolean	isSkipRemovals()	Returns true if 'remove all' settings should be ignored in the referenced master configuration.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_TEMPLATE

public static final java.lang.String PARAM_TEMPLATE

The 'template' parameter.

See Also:

Constant Field Values

Constructor Detail

ConfigReferenceMeta

public ConfigReferenceMeta()

Creates a new, empty instance.

ConfigReferenceMeta

public ConfigReferenceMeta(java.util.Map<java.lang.String,java.lang.String[]> params)

Creates a new instance from the parameters from a master configuration link.

Parameters:

params - the parameters for the metadata

Method Detail

combine

public CmsADEConfigDataInternal.ConfigReferenceMeta combine(CmsADEConfigDataInternal.ConfigReferenceMeta next)

If this object is the metadata for a link to a master configuration M, and 'next' is the metadata for a link from M to some other master configuration N, combines the metadata into a single object and returns it.

Parameters:

next - the metadata to combine this object with

Returns:

the combined metadata

getTemplate

public java.lang.String getTemplate()

Gets the template identifier.

The template identifier should be one of the template context keys provided by a template provider.

Returns:

the template identifier

isSkipRemovals

public boolean isSkipRemovals()

Returns true if 'remove all' settings should be ignored in the referenced master configuration.

Returns:

if true, 'remove all' settings are ignored in the referenced master configuration

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()