Package com.microstrategy.web.platform

Class AbstractConfigurableContainerServices.AbstractContainerStringCollection

java.lang.Object

com.microstrategy.web.platform.AbstractConfigurableContainerServices.AbstractContainerStringCollection

All Implemented Interfaces:

ContainerStringCollection

Enclosing class:

AbstractConfigurableContainerServices

protected abstract class AbstractConfigurableContainerServices.AbstractContainerStringCollection
extends java.lang.Object
implements ContainerStringCollection

Abstract class for string collection classes.

Since:

MicroStrategy Web 8.0.2

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractContainerStringCollection()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName(int index)	This returns a name at a specific numeric index in this collection.
int	getNameCount()	This returns the number of unique names (keys) in this collection.
protected abstract java.util.LinkedHashMap<java.lang.String,java.lang.Object>	getStringCollection()
java.lang.String	getStringValue(java.lang.String name)	This returns a the first string value associated with a given name (key) in this collection.
java.lang.String	getStringValue(java.lang.String name, int index)	This returns a specific string value associated with a given name (key) in this collection.
int	getStringValueCount(java.lang.String name)	This returns the number of string values associated with a given name (key) in this collection.
java.lang.Object	getValue(java.lang.String name)	This returns a value associated with a given name (key) in this collection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microstrategy.web.platform.ContainerStringCollection

getSource

Constructor Detail

AbstractContainerStringCollection

protected AbstractContainerStringCollection()

Method Detail

getStringCollection

protected abstract java.util.LinkedHashMap<java.lang.String,java.lang.Object> getStringCollection()

getStringValueCount

public int getStringValueCount(java.lang.String name)

Description copied from interface: ContainerStringCollection

This returns the number of string values associated with a given name (key) in this collection. For most collections (such as the Query String collection, the Form Data collection and the Cookie collection), all values are represented as strings. However, for the Session collection, many of the values are not Strings and do not contribute to this count.

Specified by:

getStringValueCount in interface ContainerStringCollection

Parameters:

name - A String representing the name of the key in this collection.

Returns:

An int representing the count of values.

getStringValue

public java.lang.String getStringValue(java.lang.String name)

Description copied from interface: ContainerStringCollection

This returns a the first string value associated with a given name (key) in this collection.

Specified by:

getStringValue in interface ContainerStringCollection

Parameters:

name - A String representing the name of the key in this collection.

Returns:

A String representing the value of the first string.

getStringValue

public java.lang.String getStringValue(java.lang.String name,
                                       int index)

Description copied from interface: ContainerStringCollection

This returns a specific string value associated with a given name (key) in this collection. Valid indices range from 0 to 1 less than the value returned by ContainerStringCollection.getStringValueCount(java.lang.String).

Specified by:

getStringValue in interface ContainerStringCollection

Parameters:

name - A String representing the name of the key in this collection.

index - An int representing the specific value to retrieve.

Returns:

A String representing the value at that index.

getName

public java.lang.String getName(int index)

Description copied from interface: ContainerStringCollection

This returns a name at a specific numeric index in this collection.

Specified by:

getName in interface ContainerStringCollection

Parameters:

index - An int representing the index of the name to return.

Returns:

The String representing the name at this index.

getNameCount

public int getNameCount()

Description copied from interface: ContainerStringCollection

This returns the number of unique names (keys) in this collection.

Specified by:

getNameCount in interface ContainerStringCollection

Returns:

An int representing the count of unique names.

getValue

public java.lang.Object getValue(java.lang.String name)

Description copied from interface: ContainerStringCollection

This returns a value associated with a given name (key) in this collection.

Specified by:

getValue in interface ContainerStringCollection

Parameters:

name - A String representing the name of the key in this collection.

Returns:

A Object representing the value for the given name.