public class

BlockPropertyAnnotationGroup

extends Object
java.lang.Object
   ↳ com.microstrategy.web.blocks.BlockPropertyAnnotationGroup

Class Overview

A BlockProperty can hold any number of annotations organized by group names. This class represents a single group of annotations, organized by its name. Syntactically, a group name begins with a simple name (no spaces) followed by a colon (':') and any number of annotations, each separated by semicolon (';').

Summary

Public Methods
BlockPropertyAnnotation addAnnotation(String name)
Adds a new annotation to this group.
BlockPropertyAnnotation getAnnotation(int index)
Returns a single annotation by its numeric index.
BlockPropertyAnnotation getAnnotation(String name, boolean create)
Returns the annotation with the supplied name.
String getGroupName()
Returns the group name.
boolean hasAnnotation(String name)
Returns whether there is annotation in this group by the supplied name.
int numAnnotations()
Returns the number of annotations in this group.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public BlockPropertyAnnotation addAnnotation (String name)

Adds a new annotation to this group.

Parameters
name The name of the new annotation.
Returns
Throws
IllegalArgumentException is thrown if an annotation already exists by this name.

public BlockPropertyAnnotation getAnnotation (int index)

Returns a single annotation by its numeric index.

Parameters
index The numeric index of the annotation to return.
Returns
Throws
IllegalArgumentException is thrown if there is no annotation at this index.
See Also

public BlockPropertyAnnotation getAnnotation (String name, boolean create)

Returns the annotation with the supplied name.

Parameters
name The name of the annotation to return.
create If the annotation does not exist, whether to create a new one.
Returns

public String getGroupName ()

Returns the group name.

Returns
  • The group name.

public boolean hasAnnotation (String name)

Returns whether there is annotation in this group by the supplied name.

Parameters
name The name of the annotation to check.
Returns
  • True if an annotation exists with this name.

public int numAnnotations ()

Returns the number of annotations in this group.

Returns
  • The number of annotations in this group.