alma.acs.logging.table.reduction

Enum Antennae

java.lang.Object

java.lang.Enum<Antennae>

alma.acs.logging.table.reduction.Antennae

All Implemented Interfaces:

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

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

The antennae whose pattern has to be searched in the logs.

Author:

acaproni

Enum Constant Summary

Enum Constants

Enum Constant and Description
CM
DA
DV
NO_ANTENNA
PM

Field Summary

Fields

Modifier and Type	Field and Description
java.util.regex.Pattern	pattern The pattern of an antenna to match in a message

Method Summary

Modifier and Type	Method and Description
static java.lang.String	matchAndReplaceAntenna(java.lang.StringBuilder messageToMatch, java.lang.String placeHolder) Check if the message contains a reference to an antenna and replace the antenna name with a place holder.
static Antennae	matchAntenna(java.lang.String messageToMatch) Check if the message contains a reference to an antenna
static Antennae	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Antennae[]	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

NO_ANTENNA

public static final Antennae NO_ANTENNA

DV

public static final Antennae DV

DA

public static final Antennae DA

PM

public static final Antennae PM

CM

public static final Antennae CM

Field Detail

pattern

public final java.util.regex.Pattern pattern

The pattern of an antenna to match in a message

Method Detail

values

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

Returns:

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

valueOf

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

matchAntenna

public static Antennae matchAntenna(java.lang.String messageToMatch)

Check if the message contains a reference to an antenna

Parameters:

messageToMatch - The message to check against an antenna name

Returns:

The antenna that matches with the message

matchAndReplaceAntenna

public static java.lang.String matchAndReplaceAntenna(java.lang.StringBuilder messageToMatch,
                                                      java.lang.String placeHolder)

Check if the message contains a reference to an antenna and replace the antenna name with a place holder. The method returns the antenna name that matched.

Parameters:

messageToMatch - The message to check against an antenna name

placeHolder - The place holder for the matched pattern

Returns:

The antenna name that matches with the message or null if the string does not match with any antenna name