org.apache.hadoop.dfs
Class UpgradeStatusReport

java.lang.Object
  org.apache.hadoop.dfs.UpgradeStatusReport

All Implemented Interfaces:

Writable

public class UpgradeStatusReport
extends Object
implements Writable

Base upgrade upgradeStatus class. Overload this class if specific status fields need to be reported. Describes status of current upgrade.

Field Summary

protected boolean	finalized
protected short	upgradeStatus
protected int	version

Constructor Summary

UpgradeStatusReport()

UpgradeStatusReport(int version, short status, boolean isFinalized)

Method Summary

String	getStatusText(boolean details) Get upgradeStatus data as a text for reporting.
short	getUpgradeStatus() Get upgrade upgradeStatus as a percentage of the total upgrade done.
int	getVersion() Get the layout version of the currently running upgrade.
boolean	isFinalized() Is current upgrade finalized.
void	readFields(DataInput in) Deserialize the fields of this object from in.
String	toString() Print basic upgradeStatus details.
void	write(DataOutput out) Serialize the fields of this object to out.

Methods inherited from class java.lang.Object

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

Field Detail

version

protected int version

upgradeStatus

protected short upgradeStatus

finalized

protected boolean finalized

Constructor Detail

UpgradeStatusReport

public UpgradeStatusReport()

UpgradeStatusReport

public UpgradeStatusReport(int version,
                           short status,
                           boolean isFinalized)

Method Detail

getVersion

public int getVersion()

Get the layout version of the currently running upgrade.

Returns:

layout version

getUpgradeStatus

public short getUpgradeStatus()

Get upgrade upgradeStatus as a percentage of the total upgrade done.

See Also:

Upgradeable.getUpgradeStatus()

isFinalized

public boolean isFinalized()

Is current upgrade finalized.

Returns:

true if finalized or false otherwise.

getStatusText

public String getStatusText(boolean details)

Get upgradeStatus data as a text for reporting. Should be overloaded for a particular upgrade specific upgradeStatus data.

Parameters:

details - true if upgradeStatus details need to be included, false otherwise

Returns:

text

toString

public String toString()

Print basic upgradeStatus details.

Overrides:

toString in class Object

write

public void write(DataOutput out)
           throws IOException

Description copied from interface: Writable

Serialize the fields of this object to out.

Specified by:

write in interface Writable

Parameters:

out - DataOuput to serialize this object into.

Throws:

IOException

readFields

public void readFields(DataInput in)
                throws IOException

Description copied from interface: Writable

Deserialize the fields of this object from in.

For efficiency, implementations should attempt to re-use storage in the existing object where possible.

Specified by:

readFields in interface Writable

Parameters:

in - DataInput to deseriablize this object from.

Throws:

IOException