org.jboss.as.controller.capability.registry

Class CapabilityId

java.lang.Object

org.jboss.as.controller.capability.registry.CapabilityId

public class CapabilityId
extends Object

Unique identifier for a capability, encapsulating its name and the context in which it exists.

Author:

Brian Stansberry (c) 2014 Red Hat Inc.

Constructor Summary

Constructors

Constructor and Description
CapabilityId(String name, CapabilityContext context)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSatisfyRequirements(CapabilityId other) Gets whether a capability with this id can satisfy a requirement represented by another id.
boolean	equals(Object o)
CapabilityContext	getContext() Gets the context in which the capability exists.
String	getName() Gets the name of the capability.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CapabilityId

public CapabilityId(String name,
            CapabilityContext context)

Method Detail

getName

public String getName()

Gets the name of the capability. Must be unique within the given context, so providers of capabilities should use a distinct namespace as part of the name. The org.wildfly namespace and any child namespaces are reserved for use by the WildFly project or its component projects itself.

Returns:

the name. Will not be null

getContext

public CapabilityContext getContext()

Gets the context in which the capability exists. A single management process may handle multiple contexts simultaneously, and a given capability may not exist in all of them. An example are the various profiles in a managed domain, some of which may have a capability registered and other may not.

Returns:

the context. Will not be null

canSatisfyRequirements

public boolean canSatisfyRequirements(CapabilityId other)

Gets whether a capability with this id can satisfy a requirement represented by another id.

Parameters:

other - the other id. Cannot be null

Returns:

true if this id has the same name as the other id, and if this id's context can satisfy requirements for the other id's context

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object