com.github.agadar.nsapi.enums.shard

Enum WAShard

java.lang.Object

java.lang.Enum<WAShard>

com.github.agadar.nsapi.enums.shard.WAShard

All Implemented Interfaces:

Shard, Serializable, Comparable<WAShard>

public enum WAShard
extends Enum<WAShard>
implements Shard

Shards available for World Assembly requests. These shards have a 1:1 correspondence with the variable fields in WorldAssembly.java, except for VoteTrack and DelegateVotes: VoteTrack fills the fields VoteTrackFor and VoteTrackAgainst, and DelegateVotes fills the fields DelegateVotesFor and DelegateVotesAgainst.

Author:

Agadar (https://github.com/Agadar/)

Enum Constant Summary

Enum Constants

Enum Constant and Description
CurrentProposals Current proposed resolutions.
DelegateLog A log containing when what delegates voted, and what for, during the resolution currently at vote.
Delegates The list of delegates.
DelegateVotes Same as DelegateLog, but only contains the last action for each delegate.
LastResolutionResult Brief description of the end result of the last proposed resolution.
Members The list of member nations.
NumberOfDelegates The number of delegates.
NumberOfMembers The number of member nations.
RecentHappenings Most recent happenings.
RecentMemberLog Most recent member log entries.
Resolution The current resolution at vote, or a specific one if an id is supplied.
VoteTrack A track record of the total votes of the resolution currently at vote.

Method Summary

Modifier and Type	Method and Description
String	shardName() Returns the underlying name of the shard.
static WAShard	valueOf(String name) Returns the enum constant of this type with the specified name.
static WAShard[]	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

NumberOfMembers

public static final WAShard NumberOfMembers

The number of member nations. Same for both councils.

NumberOfDelegates

public static final WAShard NumberOfDelegates

The number of delegates. Same for both councils.

Delegates

public static final WAShard Delegates

The list of delegates. Same for both councils.

Members

public static final WAShard Members

The list of member nations. Same for both councils.

RecentHappenings

public static final WAShard RecentHappenings

Most recent happenings. Same for both councils.

RecentMemberLog

public static final WAShard RecentMemberLog

Most recent member log entries. Same for both councils.

CurrentProposals

public static final WAShard CurrentProposals

Current proposed resolutions.

Resolution

public static final WAShard Resolution

The current resolution at vote, or a specific one if an id is supplied.

VoteTrack

public static final WAShard VoteTrack

A track record of the total votes of the resolution currently at vote. Only works in conjunction with the Resolution shard.

DelegateLog

public static final WAShard DelegateLog

A log containing when what delegates voted, and what for, during the resolution currently at vote. Only works in conjunction with the Resolution shard.

DelegateVotes

public static final WAShard DelegateVotes

Same as DelegateLog, but only contains the last action for each delegate. Only works in conjunction with the Resolution shard.

LastResolutionResult

public static final WAShard LastResolutionResult

Brief description of the end result of the last proposed resolution.

Method Detail

values

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

Returns:

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

valueOf

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

shardName

public String shardName()

Description copied from interface: Shard

Returns the underlying name of the shard.

Specified by:

shardName in interface Shard

Returns:

the underlying name of the shard