Package com.microstrategy.web.blocks

Class BlockPropertyAnnotationGroups

  • public class BlockPropertyAnnotationGroups
extends java.lang.Object
    This class holds a collections of annotation groups. A BlockProperty can hold any number of annotations, organized into named groups. These annotations are used by downstream tools (typically renderers). An annotation will not affect the way that a BlockProperty stores a value. Syntactically, any number of annotation groups can be specified, separating each by spaces.
    Since:
    MicroStrategy Web 9.0.0
    See Also:
    BlockPropertyAnnotationGroup, BlockPropertyAnnotation

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      BlockPropertyAnnotationGroup getGroup​(int index)
      Returns the annotation group at the specified index.
      BlockPropertyAnnotationGroup getGroup​(java.lang.String groupName, boolean create)
      Returns the annotation group with the specified name.
      boolean hasGroup​(java.lang.String groupName)
      Returns whether there is a group with the supplied name.
      int numGroups()
      Returns the number of annotation groups.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • numGroups

        public int numGroups()
        Returns the number of annotation groups.
        Returns:
        The number of BlockPropertyAnnotationGroup instances.

      • getGroup

        public BlockPropertyAnnotationGroup getGroup​(int index)
        Returns the annotation group at the specified index.
        Parameters:
        index - The index of the annotation group to return.
        Returns:
        The BlockPropertyAnnotationGroup at the specified index.
        Throws:
        java.lang.IllegalArgumentException - is thrown if there is no annotation group at this index.

      • getGroup

        public BlockPropertyAnnotationGroup getGroup​(java.lang.String groupName,
                                             boolean create)
        Returns the annotation group with the specified name.
        Parameters:
        groupName - The name of the annotation group to return.
        create - If the annotation does not exist, then this parameter indicates whether one should be created.
        Returns:
        The BlockPropertyAnnotationGroup with the specified name (or a new one if 'create' is true) or null if no annotation group exists with the supplied name (and 'create' is false).

      • hasGroup

        public boolean hasGroup​(java.lang.String groupName)
        Returns whether there is a group with the supplied name.
        Parameters:
        groupName - The name of the group.
        Returns:
        True if there is an annotation group with this name.