com.googlecode.jmxtrans.model.output

Class BaseOutputWriter

java.lang.Object

com.googlecode.jmxtrans.model.output.BaseOutputWriter

All Implemented Interfaces:

OutputWriter, OutputWriterFactory, java.lang.AutoCloseable

Direct Known Subclasses:

StdOutWriter.W

@NotThreadSafe
public abstract class BaseOutputWriter
extends java.lang.Object
implements OutputWriter, OutputWriterFactory

Implements the common code for output filters. Note that the use of a non threadsafe @link{Map} makes this class non threadsafe.

Author:

jon

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BINARY_PATH
static java.lang.String	BOOLEAN_AS_NUMBER
static java.lang.String	DEBUG
static java.lang.String	HOST
static java.lang.String	OUTPUT_FILE
static java.lang.String	PORT
static java.lang.String	TEMPLATE_FILE
static java.lang.String	TYPE_NAMES

Constructor Summary

Constructors

Constructor and Description
BaseOutputWriter(com.google.common.collect.ImmutableList<java.lang.String> typeNames, boolean booleanAsNumber, java.lang.Boolean debugEnabled, java.util.Map<java.lang.String,java.lang.Object> settings)

Method Summary

Modifier and Type	Method and Description
void	close()
OutputWriter	create()
void	doWrite(Server server, Query query, java.lang.Iterable<Result> results)
protected <T> T	firstNonNull(T first, T second, T third)
protected java.lang.String	getConcatedTypeNameValues(java.lang.String typeNameStr) Given a typeName string, get the first match from the typeNames setting.
java.util.Map<java.lang.String,java.lang.Object>	getSettings() Deprecated. Don't use the settings Map, please extract necessary bits at construction time.
protected abstract void	internalWrite(Server server, Query query, com.google.common.collect.ImmutableList<Result> results)
void	start()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.googlecode.jmxtrans.model.OutputWriter

validateSetup

Field Detail

HOST

public static final java.lang.String HOST

See Also:

Constant Field Values

PORT

public static final java.lang.String PORT

See Also:

Constant Field Values

OUTPUT_FILE

public static final java.lang.String OUTPUT_FILE

See Also:

Constant Field Values

TEMPLATE_FILE

public static final java.lang.String TEMPLATE_FILE

See Also:

Constant Field Values

BINARY_PATH

public static final java.lang.String BINARY_PATH

See Also:

Constant Field Values

DEBUG

public static final java.lang.String DEBUG

See Also:

Constant Field Values

TYPE_NAMES

public static final java.lang.String TYPE_NAMES

See Also:

Constant Field Values

BOOLEAN_AS_NUMBER

public static final java.lang.String BOOLEAN_AS_NUMBER

See Also:

Constant Field Values

Constructor Detail

BaseOutputWriter

public BaseOutputWriter(com.google.common.collect.ImmutableList<java.lang.String> typeNames,
                        boolean booleanAsNumber,
                        java.lang.Boolean debugEnabled,
                        java.util.Map<java.lang.String,java.lang.Object> settings)

Method Detail

firstNonNull

protected <T> T firstNonNull(@Nullable
                             T first,
                             @Nullable
                             T second,
                             @Nullable
                             T third)

getSettings

@Deprecated
public java.util.Map<java.lang.String,java.lang.Object> getSettings()

Deprecated. Don't use the settings Map, please extract necessary bits at construction time.

Description copied from interface: OutputWriter

Settings allow you to configure your Writers with whatever they might need.

Specified by:

getSettings in interface OutputWriter

getConcatedTypeNameValues

protected java.lang.String getConcatedTypeNameValues(java.lang.String typeNameStr)

Given a typeName string, get the first match from the typeNames setting. In other words, suppose you have:

typeName=name=PS Eden Space,type=MemoryPool

If you addTypeName("name"), then it'll retrieve 'PS Eden Space' from the string

start

public void start()
           throws LifecycleException

Specified by:

start in interface OutputWriter

Throws:

LifecycleException

close

public void close()
           throws LifecycleException

Specified by:

close in interface OutputWriter

Specified by:

close in interface java.lang.AutoCloseable

Throws:

LifecycleException

doWrite

public final void doWrite(Server server,
                          Query query,
                          java.lang.Iterable<Result> results)
                   throws java.lang.Exception

Specified by:

doWrite in interface OutputWriter

Throws:

java.lang.Exception

internalWrite

protected abstract void internalWrite(Server server,
                                      Query query,
                                      com.google.common.collect.ImmutableList<Result> results)
                               throws java.lang.Exception

Throws:

java.lang.Exception

create

public OutputWriter create()

Specified by:

create in interface OutputWriterFactory