Package agents.markets.meritOrder.books

Enum OrderBook.DistributionMethod

java.lang.Object

java.lang.Enum<OrderBook.DistributionMethod>

agents.markets.meritOrder.books.OrderBook.DistributionMethod

All Implemented Interfaces:

Serializable, Comparable<OrderBook.DistributionMethod>

Enclosing class:

OrderBook

public static enum OrderBook.DistributionMethod
extends Enum<OrderBook.DistributionMethod>

Method of how to award energy across multiple price-setting bids

Enum Constant Summary

Enum Constants

Enum Constant	Description
FIRST_COME_FIRST_SERVE	Bids are awarded in the order they appear after sorting the order book
RANDOMIZE	Bids with the same price are awarded in a random order
SAME_SHARES	Bids with the same price are all awarded the same share

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FIRST_COME_FIRST_SERVE

public static final OrderBook.DistributionMethod FIRST_COME_FIRST_SERVE

Bids are awarded in the order they appear after sorting the order book

RANDOMIZE

public static final OrderBook.DistributionMethod RANDOMIZE

Bids with the same price are awarded in a random order

SAME_SHARES

public static final OrderBook.DistributionMethod SAME_SHARES

Bids with the same price are all awarded the same share

Method Detail

values

public static OrderBook.DistributionMethod[] 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 (OrderBook.DistributionMethod c : OrderBook.DistributionMethod.values())
    System.out.println(c);

Returns:

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

valueOf

public static OrderBook.DistributionMethod 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