Package org.xwiki.model

Enum EntityType

  • All Implemented Interfaces:
    Serializable, Comparable<EntityType>
    public enum EntityType
extends Enum<EntityType>
    Represents a type of entity (ie a Model Object such as a Wiki, a Space, a Document, an Attachment, etc).
    Since:
    2.2M1
    Version:
    $Id: f301ef99009961dc9c7107a7211aa71824191685 $

    • Enum Constant Detail

      • WIKI

        public static final EntityType WIKI
        Represents a Wiki Entity.

      • SPACE

        public static final EntityType SPACE
        Represents a Space Entity.

      • DOCUMENT

        public static final EntityType DOCUMENT
        Represents a Document Entity.

      • ATTACHMENT

        public static final EntityType ATTACHMENT
        Represents an Attachment Entity.

      • OBJECT

        public static final EntityType OBJECT
        Represents an Object Entity.

      • OBJECT_PROPERTY

        public static final EntityType OBJECT_PROPERTY
        Represents an Object Property Entity.

      • CLASS_PROPERTY

        public static final EntityType CLASS_PROPERTY
        Represents a class property entity.
        Since:
        3.2M1

      • BLOCK

        public static final EntityType BLOCK
        Represents a structured part of the content of a document or an object property.
        Since:
        6.0M1

      • PAGE

        public static final EntityType PAGE
        Represents a Page Entity.
        Since:
        10.6RC1

      • PAGE_ATTACHMENT

        public static final EntityType PAGE_ATTACHMENT
        Represents an Attachment Entity in a page.
        Since:
        10.6RC1

      • PAGE_OBJECT

        public static final EntityType PAGE_OBJECT
        Represents an Object Entity in a page.
        Since:
        10.6RC1

      • PAGE_OBJECT_PROPERTY

        public static final EntityType PAGE_OBJECT_PROPERTY
        Represents an Object Property Entity in a page.
        Since:
        10.6RC1

      • PAGE_CLASS_PROPERTY

        public static final EntityType PAGE_CLASS_PROPERTY
        Represents a class property entity in a page.
        Since:
        10.6RC1

    • Method Detail

      • values

        public static EntityType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (EntityType c : EntityType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static EntityType valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getLowerCase

        public String getLowerCase()
        Returns:
        the lower case String version of the enum
        Since:
        6.2.1

      • getAllowedParents

        public List<EntityType> getAllowedParents()
        Returns:
        the list of allowed parent for this entity type
        Since:
        10.6RC1

      • isAllowedAncestor

        public boolean isAllowedAncestor​(EntityType type)
        Parameters:
        type - the type
        Returns:
        true of the passed type is a possible ancestor of the passed type
        Since:
        10.6RC1