mondrian.calc
Enum ResultStyle

java.lang.Object
  java.lang.Enum<ResultStyle>
      mondrian.calc.ResultStyle

All Implemented Interfaces:

Serializable, Comparable<ResultStyle>

public enum ResultStyle
extends Enum<ResultStyle>

Enumeration of ways that a compiled expression can return its result to its caller.

Version:

$Id: //open/mondrian-release/3.0/src/main/mondrian/calc/ResultStyle.java#2 $

Author:

jhyde

Enum Constant Summary

ANY
Indicates that caller will accept any applicable style.

ITERABLE
Indicates that the expression returns its result as an Iterable which must not be modified by the caller.

LIST
Indicates that the expression returns its result as a list which must not be modified by the caller.

MUTABLE_LIST
Indicates that the expression returns its result as a list which may safely be modified by the caller.

VALUE
Indicates that the expression results its result as an immutable value.

VALUE_NOT_NULL
Indicates that the expression results its result as an immutable value which will never be null.

Field Summary

static List<ResultStyle>	ANY_LIST
static List<ResultStyle>	ITERABLE_ANY
static List<ResultStyle>	ITERABLE_LIST
static List<ResultStyle>	ITERABLE_LIST_MUTABLELIST
static List<ResultStyle>	ITERABLE_LIST_MUTABLELIST_ANY
static List<ResultStyle>	ITERABLE_MUTABLELIST
static List<ResultStyle>	ITERABLE_MUTABLELIST_LIST
static List<ResultStyle>	ITERABLE_ONLY
static List<ResultStyle>	LIST_MUTABLELIST
static List<ResultStyle>	LIST_ONLY
static List<ResultStyle>	MUTABLELIST_LIST
static List<ResultStyle>	MUTABLELIST_ONLY

Method Summary

static ResultStyle	valueOf(String name) Returns the enum constant of this type with the specified name.
static ResultStyle[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ANY

public static final ResultStyle ANY

Indicates that caller will accept any applicable style.

MUTABLE_LIST

public static final ResultStyle MUTABLE_LIST

Indicates that the expression returns its result as a list which may safely be modified by the caller.

LIST

public static final ResultStyle LIST

Indicates that the expression returns its result as a list which must not be modified by the caller.

ITERABLE

public static final ResultStyle ITERABLE

Indicates that the expression returns its result as an Iterable which must not be modified by the caller.

VALUE

public static final ResultStyle VALUE

Indicates that the expression results its result as an immutable value. This is typical for expressions which return string, datetime and numeric values.

VALUE_NOT_NULL

public static final ResultStyle VALUE_NOT_NULL

Indicates that the expression results its result as an immutable value which will never be null. This is typical for expressions which return string, datetime and numeric values.

Field Detail

ANY_LIST

public static final List<ResultStyle> ANY_LIST

ITERABLE_ONLY

public static final List<ResultStyle> ITERABLE_ONLY

MUTABLELIST_ONLY

public static final List<ResultStyle> MUTABLELIST_ONLY

LIST_ONLY

public static final List<ResultStyle> LIST_ONLY

ITERABLE_ANY

public static final List<ResultStyle> ITERABLE_ANY

ITERABLE_LIST

public static final List<ResultStyle> ITERABLE_LIST

ITERABLE_MUTABLELIST

public static final List<ResultStyle> ITERABLE_MUTABLELIST

ITERABLE_LIST_MUTABLELIST

public static final List<ResultStyle> ITERABLE_LIST_MUTABLELIST

LIST_MUTABLELIST

public static final List<ResultStyle> LIST_MUTABLELIST

MUTABLELIST_LIST

public static final List<ResultStyle> MUTABLELIST_LIST

ITERABLE_LIST_MUTABLELIST_ANY

public static final List<ResultStyle> ITERABLE_LIST_MUTABLELIST_ANY

ITERABLE_MUTABLELIST_LIST

public static final List<ResultStyle> ITERABLE_MUTABLELIST_LIST

Method Detail

values

public static final ResultStyle[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(ResultStyle c : ResultStyle.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static ResultStyle valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name