de.zmt.output

Class Output.CollectorOption

java.lang.Object

de.zmt.output.Output.CollectorOption

Enclosing class:

Output

public abstract static class Output.CollectorOption
extends Object

Output.CollectorOption specify how an added Collector is handled by the Output object where it is added.

Method Summary

Modifier and Type	Method and Description
static Output.CollectorOption	collectInterval(int collectInterval) Creates a Output.CollectorOption that associates the collector to be added with a collect interval.
static Output.CollectorOption	hidden(boolean hidden) Creates a Output.CollectorOption that associates the collector to be added with a hidden state.
static Output.CollectorOption	interval(int interval) Creates a Output.CollectorOption that associates the collector to be added with a step interval.
static Output.CollectorOption	name(String name) Creates a Output.CollectorOption that associates the collector with a custom name.
static Output.CollectorOption	writeInterval(int writeInterval) Creates a Output.CollectorOption that associates the collector to be added with a write interval.
static Output.CollectorOption	writer(OutputWriter writer) Creates a Output.CollectorOption that associates the collector to be added with a custom OutputWriter.
static Output.CollectorOption	writer(Path subPath) Creates a Output.CollectorOption that associates the collector to be added with the default writer.

Methods inherited from class java.lang.Object

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

Method Detail

name

public static Output.CollectorOption name(String name)

Creates a Output.CollectorOption that associates the collector with a custom name.

Parameters:

name - the custom name to be associated

Returns:

the requested Output.CollectorOption

See Also:

Collector.getName()

writer

public static Output.CollectorOption writer(OutputWriter writer)

Creates a Output.CollectorOption that associates the collector to be added with a custom OutputWriter.

Parameters:

writer - the OutputWriter to be associated

Returns:

the requested Output.CollectorOption

writer

public static Output.CollectorOption writer(Path subPath)

Creates a Output.CollectorOption that associates the collector to be added with the default writer.

Parameters:

subPath - the sub path which will be resolved relatively

Returns:

the requested Output.CollectorOption

See Also:

Collector.createWriter(Path)

interval

public static Output.CollectorOption interval(int interval)

Creates a Output.CollectorOption that associates the collector to be added with a step interval. The given interval is used for collection and writing. Collectors without associated interval collect on every step.

Parameters:

interval - the step interval to be associated

Returns:

the requested Output.CollectorOption

See Also:

collectInterval(int), writeInterval(int)

collectInterval

public static Output.CollectorOption collectInterval(int collectInterval)

Creates a Output.CollectorOption that associates the collector to be added with a collect interval. Collectors without associated interval collect on every step.

Parameters:

collectInterval - the step interval to be associated

Returns:

the requested Output.CollectorOption

writeInterval

public static Output.CollectorOption writeInterval(int writeInterval)

Creates a Output.CollectorOption that associates the collector to be added with a write interval. Collectors without associated interval write on every step.

Parameters:

writeInterval - the step interval to be associated

Returns:

the requested Output.CollectorOption

hidden

public static Output.CollectorOption hidden(boolean hidden)

Creates a Output.CollectorOption that associates the collector to be added with a hidden state. When true the collector will be hidden in inspector.

Parameters:

hidden - the hidden state

Returns:

the requested Output.CollectorOption