Package org.jboss.as.controller.capability

Class AbstractCapability

  • All Implemented Interfaces:
    Capability
    Direct Known Subclasses:
    RuntimeCapability
    @Deprecated
public abstract class AbstractCapability
extends Object
implements Capability
    Deprecated.
    Will be made non-public in a future release.
    Base class for a core or subsystem capability.
    Author:
    Brian Stansberry (c) 2014 Red Hat Inc.

    • Constructor Detail

      • AbstractCapability

        @Deprecated
protected AbstractCapability​(String name,
                             boolean dynamic,
                             Set<String> requirements,
                             Set<String> optionalRequirements,
                             Set<String> runtimeOnlyRequirements,
                             Set<String> dynamicRequirements,
                             Set<String> dynamicOptionalRequirements,
                             Function<PathAddress,​String[]> dynamicNameMapper)
        Deprecated.
        Expected to be removed or hidden in the next WildFly Core release
        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 - Ignored. May be null
        runtimeOnlyRequirements - Ignored. May be null
        dynamicRequirements - Ignored. May be null
        dynamicOptionalRequirements - Ignored. May be null
        dynamicNameMapper - a function to be used to convert from a PathAddress to the dynamic elements in a dynamically named capability. May be null

    • Method Detail

      • getRequirements

        public Set<String> getRequirements()
        Deprecated.
        Description copied from interface: Capability
        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()
        Deprecated.
        Description copied from interface: Capability
        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()
        Deprecated.
        Description copied from interface: Capability
        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()
        Deprecated.
        Description copied from interface: Capability
        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()
        Deprecated.
        Description copied from interface: Capability
        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()
        Deprecated.
        Description copied from interface: Capability
        Gets whether this capability is a dynamically named one, whose runtime variants will have a dynamic element added to the base name provided by Capability.getName().
        Specified by:
        isDynamicallyNamed in interface Capability
        Returns:
        true if this capability is dynamically named

      • getDynamicName

        public String getDynamicName​(String dynamicNameElement)
        Deprecated.
        Description copied from interface: Capability
        Gets the full name of a capability, 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

      • equals

        public boolean equals​(Object o)
        Deprecated.
        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()
        Deprecated.
        Overrides:
        hashCode in class Object