com.cosylab.logging.engine.audience

Enum Audience.AudienceInfo

java.lang.Object

java.lang.Enum<Audience.AudienceInfo>

com.cosylab.logging.engine.audience.Audience.AudienceInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Audience.AudienceInfo>

Enclosing interface:

Audience

public static enum Audience.AudienceInfo
extends java.lang.Enum<Audience.AudienceInfo>

The known audiences

Author:

acaproni

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENGINEER
OPERATOR
SCILOG

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	name The name of the audience as it appears in the menu items and so on
java.lang.String	shortName The short name used for example in the command line.

Method Summary

Modifier and Type	Method and Description
static Audience.AudienceInfo	fromShortName(java.lang.String name) Return the audience corresponding to the passed short name.
Audience	getAudience()
static java.lang.String[]	getNames()
static java.lang.String[]	getShortNames() Return the names of the audiences that can be used as command line params or as java proprties.
static Audience.AudienceInfo[]	getTypes()
java.lang.String	toString()
static Audience.AudienceInfo	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Audience.AudienceInfo[]	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

ENGINEER

public static final Audience.AudienceInfo ENGINEER

OPERATOR

public static final Audience.AudienceInfo OPERATOR

SCILOG

public static final Audience.AudienceInfo SCILOG

Field Detail

name

public final java.lang.String name

The name of the audience as it appears in the menu items and so on

shortName

public final java.lang.String shortName

The short name used for example in the command line. >

See Also:

fromShortName(String)

Method Detail

values

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

Returns:

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

valueOf

public static Audience.AudienceInfo 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

getAudience

public Audience getAudience()

Returns:

The audience of the given type

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Audience.AudienceInfo>

getTypes

public static Audience.AudienceInfo[] getTypes()

Returns:

the defined audiences types

getNames

public static java.lang.String[] getNames()

Returns:

The names of the audiences

getShortNames

public static java.lang.String[] getShortNames()

Return the names of the audiences that can be used as command line params or as java proprties.

Returns:

The short names of the audiences

fromShortName

public static Audience.AudienceInfo fromShortName(java.lang.String name)

Return the audience corresponding to the passed short name.

This method can be useful when the user write the name of the audience for example as a parameter in the command line or in a java property.

The comparison between the passed string and the short name of the audience is case insensitive.

Parameters:

name - The short name of the audience

Returns:

The audience having this short name or null if an audience with that short name does not exist

See Also:

shortName