com.partnersoft.core

Enum Sandbox

java.lang.Object

java.lang.Enum<Sandbox>

com.partnersoft.core.Sandbox

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Sandbox>

public enum Sandbox
extends java.lang.Enum<Sandbox>

A sandbox is a non-"live" version of a customer install intended for testing, training, or similar purpose. By extension to foolish consistency, the normal "live" version is also considered to be a sandbox.

For our purposes, these have names, descriptions, and color codes so that e.g. GUIs and reports can be clearly labelled as coming from a sandbox.

Copyright 2012 Partner Software, Inc.

Author:

Paul Reavis

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCEPTANCE
BETA
DEMO
DEVELOPMENT
PRODUCTION
PROTOTYPE
TRAINING
TROUBLESHOOTING

Method Summary

Methods

Modifier and Type	Method and Description
static Sandbox	forName(java.lang.String name)
int	getBackgroundColorRgb()
java.lang.String	getDescription()
int	getForegroundColorRgb()
int	getId() Numeric ID for this sandbox.
java.lang.String	getName()
static java.util.List<Sandbox>	listSandboxes()
static java.util.List<java.lang.String>	listSandboxNames()
java.lang.String	toString()
int	transformPortNumber(int portNumber) For sandboxes other than production, modifies the portNumber in such a way that it will not conflict with any other sandbox (including production).
static Sandbox	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Sandbox[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PRODUCTION

public static final Sandbox PRODUCTION

TRAINING

public static final Sandbox TRAINING

DEMO

public static final Sandbox DEMO

ACCEPTANCE

public static final Sandbox ACCEPTANCE

BETA

public static final Sandbox BETA

DEVELOPMENT

public static final Sandbox DEVELOPMENT

PROTOTYPE

public static final Sandbox PROTOTYPE

TROUBLESHOOTING

public static final Sandbox TROUBLESHOOTING

Method Detail

values

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

Returns:

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

valueOf

public static Sandbox valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

forName

public static Sandbox forName(java.lang.String name)

listSandboxes

public static java.util.List<Sandbox> listSandboxes()

listSandboxNames

public static java.util.List<java.lang.String> listSandboxNames()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Sandbox>

getName

public java.lang.String getName()

getId

public int getId()

Numeric ID for this sandbox. Used for various shady numeric purposes.

Returns:

getDescription

public java.lang.String getDescription()

getBackgroundColorRgb

public int getBackgroundColorRgb()

getForegroundColorRgb

public int getForegroundColorRgb()

transformPortNumber

public int transformPortNumber(int portNumber)

For sandboxes other than production, modifies the portNumber in such a way that it will not conflict with any other sandbox (including production).

Parameters:

portNumber - original port number

Returns:

transformed port number