org.graylog2.gelfclient

Enum GelfTransports

java.lang.Object

java.lang.Enum<GelfTransports>

org.graylog2.gelfclient.GelfTransports

All Implemented Interfaces:

Serializable, Comparable<GelfTransports>

public enum GelfTransports
extends Enum<GelfTransports>

Factory for building a GelfTransport.

Enum Constant Summary

Enum Constants

Enum Constant and Description
TCP
UDP

Method Summary

Modifier and Type	Method and Description
static GelfTransport	create(GelfConfiguration config) Creates a GelfTransport from the given configuration.
static GelfTransport	create(GelfTransports transport, GelfConfiguration config) Creates a GelfTransport from the given protocol and configuration.
static GelfTransports	valueOf(String name) Returns the enum constant of this type with the specified name.
static GelfTransports[]	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

TCP

public static final GelfTransports TCP

UDP

public static final GelfTransports UDP

Method Detail

values

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

Returns:

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

valueOf

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

create

public static GelfTransport create(GelfTransports transport,
                                   GelfConfiguration config)

Creates a GelfTransport from the given protocol and configuration.

Parameters:

transport - the transport protocol to use

config - the GelfConfiguration to pass to the transport

Returns:

An initialized and started GelfTransport

create

public static GelfTransport create(GelfConfiguration config)

Creates a GelfTransport from the given configuration.

Parameters:

config - the GelfConfiguration to pass to the transport

Returns:

An initialized and started GelfTransport