Class AbstractCategories
- java.lang.Object
-
- com.microstrategy.web.objects.admin.monitors.AbstractCategories
-
- All Implemented Interfaces:
Categories
public abstract class AbstractCategories extends java.lang.Object implements Categories
The AbstractCategories class is a base class which can be subclassed to implement the (@link Categories} Interface. Most usages of the API will not require for the user to create a subclass of this class.- Since:
- MicroStrategy Web 7.5.0
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractCategories()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
add(Category c)
protected void
clear()
java.util.Enumeration
elements()
Returns a java.util.Enumeration object which contains all the objects in this collection.Category
get(int i)
Returns theCategory
at the given index.Category
getItemByName(java.lang.String name)
Searches the collection for aCategory
with the given name, and returns it.boolean
isEmpty()
Returns whether the collection is empty.protected void
remove(java.lang.String categoryName)
int
size()
Returns the current size of the Categories collection.
-
-
-
Method Detail
-
get
public Category get(int i)
Description copied from interface:Categories
Returns theCategory
at the given index.- Specified by:
get
in interfaceCategories
- Parameters:
i
- The 0-based index of the item to retrieve.- Returns:
- A
Category
object at the given index.
-
size
public int size()
Description copied from interface:Categories
Returns the current size of the Categories collection.- Specified by:
size
in interfaceCategories
- Returns:
- The number of items in the collection.
-
getItemByName
public Category getItemByName(java.lang.String name) throws java.lang.IllegalArgumentException
Description copied from interface:Categories
Searches the collection for aCategory
with the given name, and returns it.- Specified by:
getItemByName
in interfaceCategories
- Parameters:
name
- The name of the Category to find.- Returns:
- The specified
Category
object. - Throws:
java.lang.IllegalArgumentException
- Thrown if no Category with the given name exists in the collection.
-
isEmpty
public boolean isEmpty()
Description copied from interface:Categories
Returns whether the collection is empty.- Specified by:
isEmpty
in interfaceCategories
- Returns:
- True if the collection is empty, false otherwise.
-
elements
public java.util.Enumeration elements()
Description copied from interface:Categories
Returns a java.util.Enumeration object which contains all the objects in this collection.- Specified by:
elements
in interfaceCategories
- Returns:
- An enumeration object with the objects in this collection.
-
add
protected void add(Category c)
-
remove
protected void remove(java.lang.String categoryName)
-
clear
protected void clear()
-
-