com.belladati.sdk.view

Enum ViewType

java.lang.Object

java.lang.Enum<ViewType>

com.belladati.sdk.view.ViewType

All Implemented Interfaces:

Serializable, Comparable<ViewType>

public enum ViewType
extends Enum<ViewType>

Indicates the type of a view. Provides information of what content to expect from the view.

Author:

Chris Hennigfeld

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHART A chart view.
KPI A KPI view.
TABLE A table view.
TEXT A text view.

Method Summary

Methods

Modifier and Type	Method and Description
String	getUri() Returns the URI to load this view's data, relative to the API URL.
static ViewType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ViewType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CHART

public static final ViewType CHART

A chart view. The view is an instance of JsonView.

KPI

public static final ViewType KPI

A KPI view. The view is an instance of JsonView.

TABLE

public static final ViewType TABLE

A table view. The view is an instance of TableView.

TEXT

public static final ViewType TEXT

A text view. The view is an instance of JsonView.

Method Detail

values

public static ViewType[] values()

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

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

Returns:

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

valueOf

public static ViewType 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

NullPointerException - if the argument is null

getUri

public String getUri()

Returns the URI to load this view's data, relative to the API URL. This method is used by the SDK internally.

Returns:

the URI to load this view's data, relative to the API URL