org.benf.cfr.reader.api

Enum OutputSinkFactory.SinkClass

java.lang.Object

java.lang.Enum<OutputSinkFactory.SinkClass>

org.benf.cfr.reader.api.OutputSinkFactory.SinkClass

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OutputSinkFactory.SinkClass>

Enclosing interface:

OutputSinkFactory

public static enum OutputSinkFactory.SinkClass
extends java.lang.Enum<OutputSinkFactory.SinkClass>

Defines the kind of object that will arrive on your sink.
All consumers should accept at least STRING.
Not all classes are appropriate to all sink types.

OutputSinkFactory.Sink instances are constructed, and used in terms of sink classes so as to ensure easy future expansion of capabilities without breaking the ABI, and without being entirely weakly typed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DECOMPILED Sinks will accept SinkReturns.Decompiled
DECOMPILED_MULTIVER Sinks will accept SinkReturns.DecompiledMultiVer
EXCEPTION_MESSAGE Sinks will accept SinkReturns.ExceptionMessage
LINE_NUMBER_MAPPING Sink will accept SinkReturns.LineNumberMappings This will contain a mapping, per method, of bytecode location in a method to the line number in the generated text.
STRING Sinks will accept a string
TOKEN_STREAM Sinks will accept a stream of SinkReturns.Token, terminating in an EOF token for any given file.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.Class<?>	sinkClass Get the type of message that the sink will be expected to take.

Method Summary

Modifier and Type	Method and Description
static OutputSinkFactory.SinkClass	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OutputSinkFactory.SinkClass[]	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

STRING

public static final OutputSinkFactory.SinkClass STRING

Sinks will accept a string

DECOMPILED

public static final OutputSinkFactory.SinkClass DECOMPILED

Sinks will accept SinkReturns.Decompiled

DECOMPILED_MULTIVER

public static final OutputSinkFactory.SinkClass DECOMPILED_MULTIVER

Sinks will accept SinkReturns.DecompiledMultiVer

EXCEPTION_MESSAGE

public static final OutputSinkFactory.SinkClass EXCEPTION_MESSAGE

Sinks will accept SinkReturns.ExceptionMessage

TOKEN_STREAM

public static final OutputSinkFactory.SinkClass TOKEN_STREAM

Sinks will accept a stream of SinkReturns.Token, terminating in an EOF token for any given file. Note that these tokens may be reused, and should not be cached.

LINE_NUMBER_MAPPING

public static final OutputSinkFactory.SinkClass LINE_NUMBER_MAPPING

Sink will accept SinkReturns.LineNumberMappings This will contain a mapping, per method, of bytecode location in a method to the line number in the generated text. Note that due to lambda inlining/bridges/friends etc, this means that methods which are not emitted in the eventual decompilation will receive line number mappings, which will point to line numbers that are visibly contained in other methods. see SinkReturns.LineNumberMapping for further details.

Field Detail

sinkClass

public final java.lang.Class<?> sinkClass

Get the type of message that the sink will be expected to take.

Method Detail

values

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

Returns:

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

valueOf

public static OutputSinkFactory.SinkClass 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