Package com.xebialabs.deployit.plugin.api.reflect

Interface Descriptor

  • public interface Descriptor
    Encapsulates the metadata about a type in the XL Deploy type system. Example of such metadata: the available properties, the implemented interfaces, the available control tasks etc.

    The Descriptor for a specific type can be retrieved using the MetadataService, which is also available as a REST API.

    • Method Detail

      • getClazz

        java.lang.Class<?> getClazz()
        Returns:
        The ConfigurationItem class object.

      • getDescription

        java.lang.String getDescription()
        Returns:
        A textual description of this type.

      • getLabel

        java.lang.String getLabel()
        Returns:
        The friendly name of the type

      • getRootName

        java.lang.String getRootName()
        Returns:
        The root name in the JCR tree.

      • getPropertyDescriptors

        java.util.Collection<PropertyDescriptor> getPropertyDescriptors()
        Note: The return-type is a Collection, but a List is actually returned. So the order of the properties is guaranteed. We cannot change the return-type as this would break binary compatibility.
        Returns:
        A list of metadata about a all the properties of this type.

      • getPropertyDescriptor

        PropertyDescriptor getPropertyDescriptor​(java.lang.String name)
        Parameters:
        name - The name of the property.
        Returns:
        The metadata for the given property name.

      • getControlTask

        MethodDescriptor getControlTask​(java.lang.String name)
        Parameters:
        name - The name of the control methods.
        Returns:
        The metadata for the given a control method name.

      • getControlTasks

        java.util.Collection<MethodDescriptor> getControlTasks()
        Returns:
        A list of metadata about a all the control methods of this type.

      • isAssignableTo

        boolean isAssignableTo​(java.lang.Class<?> clazz)
        Parameters:
        clazz - A ConfigurationItem class object.
        Returns:
        Whether this type is a subtype or has the same type as the type of the given CI class.

      • isAssignableTo

        boolean isAssignableTo​(Type type)
        Parameters:
        type - A CI type.
        Returns:
        Whether this type is a subtype or has the same type as the given type.

      • getSuperClasses

        java.util.List<Type> getSuperClasses()
        Returns:
        The list of all the super classes of this ConfigurationItem.

      • getInterfaces

        java.util.Set<Type> getInterfaces()
        Returns:
        The set of all the interfaces this ConfigurationItem implements.

      • isVirtual

        boolean isVirtual()
        Returns:
        Whether this type is a virtual type.

      • isVersioned

        boolean isVersioned()
        Returns:
        Whether or not this is a versioned type, i.e. whether or not the JCR version history for CIs of this type is kept.

      • getIcon

        java.lang.String getIcon()
        Returns:
        The relative path to the icon for this type.

      • toString

        java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • getDeployableType

        Type getDeployableType()
        Only applicable for Deployeds.
        Returns:
        The Deployable type that created this deployed.

      • getContainerType

        Type getContainerType()
        Only applicable for Deployeds.
        Returns:
        The Container type this deployed can be deployed to.

      • isInspectable

        boolean isInspectable()
        Returns:
        Whether this type supports inspection.