Module com.aoapps.web.resources.registry

Package com.aoapps.web.resources.registry

Class Registry

java.lang.Object

com.aoapps.web.resources.registry.Registry

All Implemented Interfaces:

Serializable

public class Registry
extends Object
implements Serializable

A registry contains a set of groups, along with activations.

TODO: Idea: Have a default group that is always active (getDefaultGroup), and when group not provided this is assumed. This would save all the group naming and activation when the intent is to have always active.

Author:

AO Industries, Inc.

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
	Registry()
protected	Registry(Registry other)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
Registry	activate(Iterables.String<?> groups)	Activates the given groups.
Registry	activate(Group.Name group)	Activates the given group.
Registry	activate(Group.Name... groups)	Activates the given groups.
Registry	activate(Iterable<Group.Name> groups)	Activates the given groups.
Registry	activate(String group)	Activates the given group.
Registry	activate(String... groups)	Activates the given groups.
Registry	copy()	Gets a deep copy of this registry.
Registry	deactivate(Iterables.String<?> groups)	Deactivates the given groups.
Registry	deactivate(Group.Name group)	Deactivates the given group.
Registry	deactivate(Group.Name... groups)	Deactivates the given groups.
Registry	deactivate(Iterable<Group.Name> groups)	Deactivates the given groups.
Registry	deactivate(String group)	Deactivates the given group.
Registry	deactivate(String... groups)	Deactivates the given groups.
Map<Group.Name,Boolean>	getActivations()	Gets an unmodifiable view of the current activations.
Group	getGroup(Group.Name name)	Gets the group for a given name, creating it if not already present.
Group	getGroup(Group.Name name, boolean createIfMissing)	Gets the group for a given name, optionally creating it if not already present.
Group	getGroup(String name)	Gets the group for a given name, creating it if not already present.
Group	getGroup(String name, boolean createIfMissing)	Gets the group for a given name, optionally creating it if not already present.
boolean	isEmpty()	Empty when there are no activations and all groups are empty.
Boolean	setActivation(Group.Name group, Boolean activation)	Sets the activation for the given group.

Methods inherited from class java.lang.Object

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

Constructor Details

Registry

public Registry()

Registry

protected Registry(Registry other)

Copy constructor.

Method Details

copy

public Registry copy()

Gets a deep copy of this registry.

getGroup

public Group getGroup(Group.Name name,
 boolean createIfMissing)

Gets the group for a given name, optionally creating it if not already present.

Parameters:

createIfMissing - When true, will create the group if missing

Returns:

The group or null when the group does not exist and createIfMissing is false.

getGroup

public Group getGroup(String name,
 boolean createIfMissing)
               throws IllegalArgumentException

Gets the group for a given name, optionally creating it if not already present.

Parameters:

createIfMissing - When true, will create the group if missing

Returns:

The group or null when the group does not exist and createIfMissing is false.

Throws:

IllegalArgumentException - See Group.Name.checkName(java.lang.String).

getGroup

public Group getGroup(Group.Name name)

Gets the group for a given name, creating it if not already present.

getGroup

public Group getGroup(String name)
               throws IllegalArgumentException

Gets the group for a given name, creating it if not already present.

Throws:

IllegalArgumentException - See Group.Name.checkName(java.lang.String).

getActivations

public Map<Group.Name,Boolean> getActivations()

Gets an unmodifiable view of the current activations.

• Boolean.TRUE indicates the group is activated by this registry.
• Boolean.FALSE indicates the group is deactivated by this registry.
• null indicates the activation is unchanged.

Groups are inactive by default, when not activated in any of the applied registries.

This mapping is not a snapshot and may reflect concurrent changes to the registry (see ConcurrentHashMap).

setActivation

public Boolean setActivation(Group.Name group,
 Boolean activation)

Sets the activation for the given group.

• Boolean.TRUE indicates the group is activated by this registry.
• Boolean.FALSE indicates the group is deactivated by this registry.
• null indicates the activation is unchanged.

The group does not need to be part of this registry. In fact, it will often be the case that the application-scope registry contains the resources while request/theme/view/page-scope registries activate them.

Parameters:

activation - When null, the activation is removed.

Returns:

The previous activation value for the group

activate

public Registry activate(Group.Name group)

Activates the given group.

activate

public Registry activate(String group)
                  throws IllegalArgumentException

Activates the given group.

Throws:

IllegalArgumentException - See Group.Name.checkName(java.lang.String).

activate

public Registry activate(Iterable<Group.Name> groups)

Activates the given groups.

activate

public Registry activate(Group.Name... groups)

Activates the given groups.

activate

public Registry activate(Iterables.String<?> groups)
                  throws IllegalArgumentException

Activates the given groups.

Throws:

IllegalArgumentException - See Group.Name.checkName(java.lang.String).

activate

public Registry activate(String... groups)
                  throws IllegalArgumentException

Activates the given groups.

Throws:

IllegalArgumentException - See Group.Name.checkName(java.lang.String).

deactivate

public Registry deactivate(Group.Name group)

Deactivates the given group.

deactivate

public Registry deactivate(String group)
                    throws IllegalArgumentException

Deactivates the given group.

Throws:

IllegalArgumentException - See Group.Name.checkName(java.lang.String).

deactivate

public Registry deactivate(Iterable<Group.Name> groups)

Deactivates the given groups.

deactivate

public Registry deactivate(Group.Name... groups)

Deactivates the given groups.

deactivate

public Registry deactivate(Iterables.String<?> groups)
                    throws IllegalArgumentException

Deactivates the given groups.

Throws:

IllegalArgumentException - See Group.Name.checkName(java.lang.String).

deactivate

public Registry deactivate(String... groups)
                    throws IllegalArgumentException

Deactivates the given groups.

Throws:

IllegalArgumentException - See Group.Name.checkName(java.lang.String).

isEmpty

public boolean isEmpty()

Empty when there are no activations and all groups are empty.

See Also:

• Group.isEmpty()