Class Environment<T extends ToolLogger>

java.lang.Object

org.openjdk.asmtools.common.Environment<T>

All Implemented Interfaces:

ILogger

Direct Known Subclasses:

JasmEnvironment, JcoderEnvironment, JdecEnvironment, JdisEnvironment

public abstract class Environment<T extends ToolLogger>
extends Object
implements ILogger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Environment.Builder<E extends Environment, T extends ToolLogger>	The Environment builder.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	FAILED
private boolean	ignorePackage
static final int	OK
private ToolInput	toolInput
(package private) T	toolLogger
private ToolOutput	toolOutput
private boolean	traceFlag
private boolean	verboseFlag

Fields inherited from interface ILogger

NOWHERE, TAB_REPLACEMENT, usagePattern

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Environment(Environment.Builder builder)

Method Summary

Modifier and Type	Method	Description
void	error(String id, Object... args)
void	error(Throwable exception)
protected DataInputStream	getDataInputStream()
String	getInfo(String id, Object... args)
T	getLogger()
DualStreamToolOutput	getOutputs()
String	getSimpleInputFileName()
String	getSourceName()	Returns the name of the source file that is used by the tool to assemble the SourceFile attribute
ToolInput	getToolInput()
ToolOutput	getToolOutput()
boolean	getVerboseFlag()
void	info(String id, Object... args)
boolean	isIgnorePackage()
boolean	isTraceFlag()
void	printException(Throwable throwable)
Environment<T>	setIgnorePackage(boolean ignorePackage)
void	setIgnoreWarningsOn()
void	setOutputs(DualStreamToolOutput nw)
void	setStrictWarningsOn()
void	setToolInput(ToolInput toolInput)
void	setToolOutput(ToolOutput toolOutput)
void	setTraceFlag(boolean flag)
Environment	setVerboseFlag(boolean value)
void	trace(String id, Object... args)
void	trace(Supplier<String> supplier)
void	traceln(String id, Object... args)
void	traceln(Supplier<String> supplier)
void	usage(List<String> ids)
void	usage(List<String> ids, Function<String,String> func)

Methods inherited from class Object

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

Methods inherited from interface ILogger

error, getCount, getResourceString, print, print, printErrorLn, println, println, warning, warning

Field Details

OK

public static final int OK

See Also:

• Constant Field Values

FAILED

public static final int FAILED

See Also:

• Constant Field Values

toolLogger

T extends ToolLogger toolLogger

ignorePackage

private boolean ignorePackage

toolInput

private ToolInput toolInput

toolOutput

private ToolOutput toolOutput

verboseFlag

private boolean verboseFlag

traceFlag

private boolean traceFlag

Constructor Details

Environment

protected Environment(Environment.Builder builder)

Parameters:

builder - the environment builder

Method Details

isTraceFlag

public boolean isTraceFlag()

setToolInput

public void setToolInput(ToolInput toolInput)
                  throws IOException,
URISyntaxException

Throws:

IOException

URISyntaxException

setTraceFlag

public void setTraceFlag(boolean flag)

setIgnoreWarningsOn

public void setIgnoreWarningsOn()

setStrictWarningsOn

public void setStrictWarningsOn()

isIgnorePackage

public boolean isIgnorePackage()

setIgnorePackage

public Environment<T> setIgnorePackage(boolean ignorePackage)

getSimpleInputFileName

public String getSimpleInputFileName()

getSourceName

public String getSourceName()

Returns the name of the source file that is used by the tool to assemble the SourceFile attribute

Returns:

the name of the source file

getToolInput

public ToolInput getToolInput()

getDataInputStream

protected DataInputStream getDataInputStream()
                                      throws URISyntaxException,
IOException

Returns:

DataInputStream or null if the method can't read a file

Throws:

URISyntaxException

IOException

traceln

public void traceln(String id,
 Object... args)

Specified by:

traceln in interface ILogger

traceln

public void traceln(Supplier<String> supplier)

trace

public void trace(String id,
 Object... args)

Specified by:

trace in interface ILogger

error

public void error(String id,
 Object... args)

Specified by:

error in interface ILogger

error

public void error(Throwable exception)

Specified by:

error in interface ILogger

trace

public void trace(Supplier<String> supplier)

info

public void info(String id,
 Object... args)

Specified by:

info in interface ILogger

getInfo

public String getInfo(String id,
 Object... args)

Specified by:

getInfo in interface ILogger

usage

public void usage(List<String> ids)

usage

public void usage(List<String> ids,
 Function<String,String> func)

printException

public void printException(Throwable throwable)

Specified by:

printException in interface ILogger

getOutputs

public DualStreamToolOutput getOutputs()

Specified by:

getOutputs in interface ILogger

setOutputs

public void setOutputs(DualStreamToolOutput nw)

Specified by:

setOutputs in interface ILogger

getToolOutput

public ToolOutput getToolOutput()

Specified by:

getToolOutput in interface ILogger

setToolOutput

public void setToolOutput(ToolOutput toolOutput)

Specified by:

setToolOutput in interface ILogger

getVerboseFlag

public boolean getVerboseFlag()

setVerboseFlag

public Environment setVerboseFlag(boolean value)

getLogger

public T getLogger()