org.mule.module.extension.internal.util

Class CapabilityUtils

java.lang.Object

org.mule.module.extension.internal.util.CapabilityUtils

public class CapabilityUtils
extends Object

Utility class for handling capabilities

Since:

3.7.0

Method Summary

Modifier and Type	Method and Description
static <T> Set<T>	getCapabilities(Set<?> capabilities, Class<T> capabilityType) Returns the items in capabilities which are instances of capabilityType
static <T> T	getSingleCapability(org.mule.extension.introspection.Capable capable, Class<T> capabilityType) Expects capable to have at most one capability of type capabilityType and returns such capability.
static <T> T	getSingleCapability(Set<?> capabilities, Class<T> capabilityType) Expects the capabilities Set to have at most one capability of type capabilityType and returns such capability.
static boolean	isCapableOf(Set<?> capabilities, Class<?> capabilityType) Returns true if {code capabilities} contains at least one item which is an instance of capabilityType

Methods inherited from class java.lang.Object

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

Method Detail

getCapabilities

public static <T> Set<T> getCapabilities(Set<?> capabilities,
                                         Class<T> capabilityType)

Returns the items in capabilities which are instances of capabilityType

Parameters:

capabilities - a Set of capabilities

capabilityType - the type of the capabilities you seek

Returns:

a sub Set of capabilities

isCapableOf

public static boolean isCapableOf(Set<?> capabilities,
                                  Class<?> capabilityType)

Returns true if {code capabilities} contains at least one item which is an instance of capabilityType

Parameters:

capabilities - a Set of capabilities

capabilityType - the type of the capabilities you seek

Returns:

true if at least one of the capabilities is of type capabilityType. false otherwise

getSingleCapability

public static <T> T getSingleCapability(org.mule.extension.introspection.Capable capable,
                                        Class<T> capabilityType)

Expects capable to have at most one capability of type capabilityType and returns such capability. If capable doesn't have a matching capability, then it returns null. If capable has more than one instance of that capability, then it throws IllegalArgumentException

Type Parameters:

T - the generic type of the capability you're looking for

Parameters:

capable - a Capable

capabilityType - a capability t ype

Returns:

A capability or null

Throws:

IllegalArgumentException - if more than one capability of type capabilityType is found

getSingleCapability

public static <T> T getSingleCapability(Set<?> capabilities,
                                        Class<T> capabilityType)

Expects the capabilities Set to have at most one capability of type capabilityType and returns such capability.

Type Parameters:

T - the generic type of the capability you're looking for

Parameters:

capabilities - a Set with capability objects

capabilityType - the Class of a certain capability type

Returns:

an instance of T or null is capabilities is empty or contains no matching item