Skip navigation links

oracle.idm.util.progress.info
Class StepInfo

java.lang.Object
oracle.idm.util.progress.info.StepInfo

All Implemented Interfaces:

java.lang.Cloneable, XmlPrintable

public class StepInfo

extends java.lang.Object

implements java.lang.Cloneable, XmlPrintable

StepsInfo represents information about the number of operation steps. For example, it may report that curently 100 of total 500 operation steps have been executed.

Field Summary

static int

UNKNOWN UNKNOWN has a value of -1 and indicates unknown number of steps.

Constructor Summary

StepInfo(int current)
Creates StepsInfo.

StepInfo(int current, int total)
Creates StepsInfo.

Method Summary

java.lang.Object	clone() Clones StepsInfo.
int	getCurrent() Getter for the current property.
int	getTotal() Getter for the total property.
void	setCurrent(int current) Setter for the current property.
void	setTotal(int total) Setter for the total property.
java.lang.String	toString() Returns a string representation of StepInfo.
void	xprint(XmlPrintWriter out) Prints stepInfo properties to the PrintWriter as an XML element.

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN

public static final int UNKNOWN

UNKNOWN has a value of -1 and indicates unknown number of steps.

See Also:

Constant Field Values

Constructor Detail

StepInfo

public StepInfo(int current,
                int total)

Creates StepsInfo.

Parameters:

current - Current number of operation steps executed so far.

total - Total number of operation steps expected to be executed.

StepInfo

public StepInfo(int current)

Creates StepsInfo.

Parameters:

current - Current number of operation steps executed so far.

Method Detail

clone

public java.lang.Object clone()

Clones StepsInfo.

Overrides:

clone in class java.lang.Object

getCurrent

public int getCurrent()

Getter for the current property. Value of UNKNOWN indicates unknown current number of steps.

Returns:

Current number of operation steps executed so far.

setCurrent

public void setCurrent(int current)

Setter for the current property. Use value of UNKNOWN to indicate unknown current number of steps.

Parameters:

current - Current number of operation steps executed so far.

getTotal

public int getTotal()

Getter for the total property. Value of UNKNOWN indicates unknown total number of steps.

Returns:

Total number of operation steps expected to be executed.

setTotal

public void setTotal(int total)

Setter for the total property. Use value of UNKNOWN to indicate unknown total number of steps.

Parameters:

total - Total number of operation steps expected to be executed.

xprint

public void xprint(XmlPrintWriter out)

Prints stepInfo properties to the PrintWriter as an XML element.

Specified by:

xprint in interface XmlPrintable

Parameters:

out - PrintWriter for printing stepInfo propeties.

toString

public java.lang.String toString()

Returns a string representation of StepInfo.

Overrides:

toString in class java.lang.Object

Skip navigation links