Module org.praxislive.base

Package org.praxislive.base

Enum Class Binding.SyncRate

java.lang.Object

java.lang.Enum<Binding.SyncRate>

org.praxislive.base.Binding.SyncRate

All Implemented Interfaces:

Serializable, Comparable<Binding.SyncRate>, Constable

Enclosing class:

Binding

public static enum Binding.SyncRate
extends Enum<Binding.SyncRate>

Rates for perdiodic syncing. Except for None, how these values translate to a sync period in milliseconds is governed by the BindingContext implementation.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
High	Sync at a high periodic rate.
Low	Sync at a low periodic rate.
Medium	Sync at a medium periodic rate.
None	No periodic sync.

Method Summary

Modifier and Type	Method	Description
static Binding.SyncRate	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Binding.SyncRate[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

None

public static final Binding.SyncRate None

No periodic sync.

Low

public static final Binding.SyncRate Low

Sync at a low periodic rate.

Medium

public static final Binding.SyncRate Medium

Sync at a medium periodic rate.

High

public static final Binding.SyncRate High

Sync at a high periodic rate.

Method Details

values

public static Binding.SyncRate[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Binding.SyncRate valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null