org.opends.server.tools

Class LDAPToolOptions

java.lang.Object

org.opends.server.tools.LDAPToolOptions

Direct Known Subclasses:

LDAPCompareOptions, LDAPDeleteOptions, LDAPModifyOptions, LDAPSearchOptions

public class LDAPToolOptions
extends Object

This class defines common options for all the operations used by the tools.

Constructor Summary

Constructors

Constructor and Description
LDAPToolOptions() Creates a the tool options instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	continueOnError() Return the continueOnError flag value.
ArrayList<Control>	getControls() Return the controls to apply to the operation.
String	getEncoding() Return the encoding value.
boolean	getVerbose() Return the verbose flag value.
void	setContinueOnError(boolean continueOnError) Set whether to use continue on error or not.
void	setControls(ArrayList<Control> controls) Specifies the set of controls to apply to the operation.
void	setEncoding(String encodingStr) Set the encoding.
void	setShowOperations(boolean showOperations) Set whether to show what would be run but not actually do it.
void	setVerbose(boolean verbose) Set verbose flag.
boolean	showOperations() Return the showOperations flag value.

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPToolOptions

public LDAPToolOptions()

Creates a the tool options instance.

Method Detail

setShowOperations

public void setShowOperations(boolean showOperations)

Set whether to show what would be run but not actually do it.

Parameters:

showOperations - True if we need to show what needs to be done.

showOperations

public boolean showOperations()

Return the showOperations flag value.

Returns:

true if the operations should only be displayed, or false if they should actually be performed.

setVerbose

public void setVerbose(boolean verbose)

Set verbose flag.

Parameters:

verbose - Indicates whether the tool should operate in verbose mode.

getVerbose

public boolean getVerbose()

Return the verbose flag value.

Returns:

true if the tool should operate in verbose mode, or false if not.

setContinueOnError

public void setContinueOnError(boolean continueOnError)

Set whether to use continue on error or not.

Parameters:

continueOnError - True if processing should continue on error, false otherwise.

continueOnError

public boolean continueOnError()

Return the continueOnError flag value.

Returns:

true if the tool should continue processing operations if an error occurs with a previous operation, or false if not.

getControls

public ArrayList<Control> getControls()

Return the controls to apply to the operation.

Returns:

The controls to apply to the operation.

setControls

public void setControls(ArrayList<Control> controls)

Specifies the set of controls to apply to the operation.

Parameters:

controls - The set of controls to apply to the operation.

setEncoding

public void setEncoding(String encodingStr)

Set the encoding.

Parameters:

encodingStr - The encoding to use for string values.

getEncoding

public String getEncoding()

Return the encoding value.

Returns:

The encoding to use for string values.