ome.smuggler.core.service.omero.impl

Class OmeCliCommandPrinter

java.lang.Object

ome.smuggler.core.service.omero.impl.OmeCliCommandPrinter

public class OmeCliCommandPrinter
extends java.lang.Object

Pretty-prints an OME CLI command, masking the values of selected options if desired.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	mask The string used to replace the value of an option to mask.

Constructor Summary

Constructors

Constructor and Description
OmeCliCommandPrinter(util.runtime.CommandBuilder command) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
java.lang.String	print() Pretty-prints the command to a string.
java.lang.String	printMasking(java.lang.Integer... index) Pretty-prints the command to a string, masking the token at the specified index.
java.lang.String	printMasking(java.lang.String... optionName) Pretty-prints the command to a string, masking the value of each specified option.

Methods inherited from class java.lang.Object

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

Field Detail

mask

public static final java.lang.String mask

The string used to replace the value of an option to mask.

See Also:

Constant Field Values

Constructor Detail

OmeCliCommandPrinter

public OmeCliCommandPrinter(util.runtime.CommandBuilder command)

Creates a new instance.

Parameters:

command - the command to pretty-print.

Throws:

java.lang.NullPointerException - if the command is null.

Method Detail

print

public java.lang.String print()

Pretty-prints the command to a string.

Returns:

the command as a string.

printMasking

public java.lang.String printMasking(java.lang.String... optionName)

Pretty-prints the command to a string, masking the value of each specified option.

Parameters:

optionName - name of an option whose value has to be masked when printing; if no list is given, nothing will be masked.

Returns:

the command as a string.

printMasking

public java.lang.String printMasking(java.lang.Integer... index)

Pretty-prints the command to a string, masking the token at the specified index.

Parameters:

index - index of a token to mask when printing; if no list is given, nothing will be masked.

Returns:

the command as a string.