Interface Category
-
- All Known Implementing Classes:
AbstractCategory
public interface Category
This class represents a Category of performance counters. A Category contains one or moreInstance
objects.- Since:
- MicroStrategy Web 7.5.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Enumeration
elements()
Returns a java.util.Enumeration object containing the objects in the collection.Instance
get(int index)
Returns theInstance
object at the given index in the collection.java.lang.String
getHelpMessage()
Returns the help message associated with the Category.Instance
getItemByName(java.lang.String name)
Searches the collection for anInstance
with the given name.java.lang.String
getLocalizedHelpMessage(java.util.Locale locale)
Returns the localized help message associated with the Category.java.lang.String
getLocalizedName(java.util.Locale locale)
Returns the localized name of the Category.java.lang.String
getName()
Returns the name of the Category.boolean
isEmpty()
Returns whether the collection is empty.int
size()
Returns the number of items in the collection.
-
-
-
Method Detail
-
getName
java.lang.String getName()
Returns the name of the Category.- Returns:
- The name of the Category.
-
getLocalizedName
java.lang.String getLocalizedName(java.util.Locale locale)
Returns the localized name of the Category.- Parameters:
locale
- Locale The locale to localize to.- Returns:
- String The localized Category name.
- Since:
- MicroStrategy Web 8.0.0
-
get
Instance get(int index) throws java.lang.IndexOutOfBoundsException
Returns theInstance
object at the given index in the collection.- Parameters:
index
- The index of the item to retrieve.- Returns:
- The
Instance
object at the given index. - Throws:
java.lang.IndexOutOfBoundsException
- Thrown if the given index is invalid.
-
isEmpty
boolean isEmpty()
Returns whether the collection is empty.- Returns:
- True if the collection is empty, false otherwise.
-
getItemByName
Instance getItemByName(java.lang.String name) throws java.lang.IllegalArgumentException
Searches the collection for anInstance
with the given name.- Parameters:
name
- The name of the Instance to return.- Returns:
- An
Instance
object with the given name. - Throws:
java.lang.IllegalArgumentException
- Thrown if no item with the given name exists in the collection.
-
size
int size()
Returns the number of items in the collection.- Returns:
- The number of items in the collection.
-
elements
java.util.Enumeration elements()
Returns a java.util.Enumeration object containing the objects in the collection.- Returns:
- An Enumeration containing the objects in this collection.
-
getHelpMessage
java.lang.String getHelpMessage()
Returns the help message associated with the Category. The help message is a longer description of the counter.- Returns:
- The help message of the Category, if one exists.
-
getLocalizedHelpMessage
java.lang.String getLocalizedHelpMessage(java.util.Locale locale)
Returns the localized help message associated with the Category. The help message is a longer description of the counter.- Parameters:
locale
- Locale The locale to localize to.- Returns:
- String The localized help mesasge of the Category, if one exists.
- Since:
- MicroStrategy Web 8.0.0
-
-