org.jboss.as.controller.capability

Class AbstractCapability

java.lang.Object

org.jboss.as.controller.capability.AbstractCapability

All Implemented Interfaces:

Capability

Direct Known Subclasses:

RuntimeCapability

public abstract class AbstractCapability
extends Object
implements Capability

Base class for a core or subsystem capability.

Author:

Brian Stansberry (c) 2014 Red Hat Inc.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCapability(String name, boolean dynamic, Set<String> requirements, Set<String> optionalRequirements, Set<String> runtimeOnlyRequirements, Set<String> dynamicRequirements, Set<String> dynamicOptionalRequirements) Creates a new capability

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDynamicName(String dynamicNameElement) Gets the full name of a capbility, including a dynamic element
Set<String>	getDynamicOptionalRequirements() Gets the names of other dynamically named capabilities upon a concrete instance of which this capability will have an optional requirement once the full name is known.
Set<String>	getDynamicRequirements() Gets the names of other dynamically named capabilities upon a concrete instance of which this capability will have a hard requirement once the full name is known.
String	getName() Gets the basic name of the capability.
Set<String>	getOptionalRequirements() Gets the names of other capabilities optionally required by this capability.
Set<String>	getRequirements() Gets the names of other capabilities required by this capability.
Set<String>	getRuntimeOnlyRequirements() Gets the names of other capabilities optionally used by this capability if they are present in the runtime, but where the use of the other capability will never be mandated by the persistent configuration.
int	hashCode()
boolean	isDynamicallyNamed() Gets whether this capability is a dynamically named one, whose runtime variants will have a dynamic element added to the base name provided by getName().
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCapability

protected AbstractCapability(String name,
                             boolean dynamic,
                             Set<String> requirements,
                             Set<String> optionalRequirements,
                             Set<String> runtimeOnlyRequirements,
                             Set<String> dynamicRequirements,
                             Set<String> dynamicOptionalRequirements)

Creates a new capability

Parameters:

name - the name of the capability. Cannot be null

requirements - names of other capabilities upon which this capability has a hard requirement. May be null

optionalRequirements - names of other capabilities upon which this capability has an optional requirement. May be null

runtimeOnlyRequirements - names of other capabilities upon which this capability has an optional, runtime-only requirement. May be null

dynamicRequirements - names of other dynamically named capabilities upon a concrete instance of which this capability will have a hard requirement once the full name is known. May be null

dynamicOptionalRequirements - names of other dynamically named capabilities upon a concrete instance of which this capability will have an optional requirement once the full name is known. May be null

Method Detail

getName

public String getName()

Gets the basic name of the capability. If isDynamicallyNamed() returns true this will be the basic name of the capability, not including any dynamic portions.

Specified by:

getName in interface Capability

Returns:

the name. Will not be null

See Also:

getDynamicName(String)

getRequirements

public Set<String> getRequirements()

Gets the names of other capabilities required by this capability. These are static requirements.

Specified by:

getRequirements in interface Capability

Returns:

the capability names. Will not be null but may be empty.

getOptionalRequirements

public Set<String> getOptionalRequirements()

Gets the names of other capabilities optionally required by this capability. Whether this capability will actually require the other capabilities is not statically known but rather depends on this capability's own configuration.

Specified by:

getOptionalRequirements in interface Capability

Returns:

the capability names. Will not be null but may be empty.

getRuntimeOnlyRequirements

public Set<String> getRuntimeOnlyRequirements()

Gets the names of other capabilities optionally used by this capability if they are present in the runtime, but where the use of the other capability will never be mandated by the persistent configuration. Differs from optional requirements in that optional requirements may or may not be specified by the persistent configuration, but if they are the capability must be present or the configuration is invalid.

Specified by:

getRuntimeOnlyRequirements in interface Capability

Returns:

the capability names. Will not be null but may be empty.

getDynamicRequirements

public Set<String> getDynamicRequirements()

Gets the names of other dynamically named capabilities upon a concrete instance of which this capability will have a hard requirement once the full name is known. It is statically known that some variant of these base capability names will be required, but the exact name will not be known until this capability's configuration is read.

Specified by:

getDynamicRequirements in interface Capability

Returns:

the capability names. Will not be null but may be empty.

getDynamicOptionalRequirements

public Set<String> getDynamicOptionalRequirements()

Gets the names of other dynamically named capabilities upon a concrete instance of which this capability will have an optional requirement once the full name is known. Whether this capability will actually require the other capabilities is not statically known but rather depends on this capability's own configuration.

Specified by:

getDynamicOptionalRequirements in interface Capability

Returns:

the capability names. Will not be null but may be empty.

isDynamicallyNamed

public boolean isDynamicallyNamed()

Gets whether this capability is a dynamically named one, whose runtime variants will have a dynamic element added to the base name provided by getName().

Specified by:

isDynamicallyNamed in interface Capability

Returns:

true if this capability is dynamically named

getDynamicName

public String getDynamicName(String dynamicNameElement)

Gets the full name of a capbility, including a dynamic element

Specified by:

getDynamicName in interface Capability

Parameters:

dynamicNameElement - the dynamic portion of the name. Cannot be null

Returns:

the full capability name

Throws:

IllegalStateException - if isDynamicallyNamed() returns false

equals

public boolean equals(Object o)

Overrides:

equals in class Object

Returns:

true if o is the same type as this object and its name is equal

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

Returns:

the value returned by getName()