Package com.perforce.p4java.client

Class BaseProgressReport

java.lang.Object

com.perforce.p4java.client.BaseProgressReport

All Implemented Interfaces:

IProgressReport

Direct Known Subclasses:

ClientProgressReport

public abstract class BaseProgressReport
extends java.lang.Object
implements IProgressReport

Base implementation of IProgressReport with state tracking. Uses boolean flags instead of bitwise operations. Corresponds to ProgressReport class in C++.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	description
protected boolean	descriptionChanged
protected boolean	isNewProgress
protected long	lastUpdateTime
protected boolean	needFinal
protected long	position
protected boolean	positionChanged
protected long	total
protected boolean	totalChanged
protected ProgressUnit	units
protected boolean	unitsChanged

Fields inherited from interface com.perforce.p4java.client.IProgressReport

CPP_DONE, CPP_FAILDONE, CPP_FLUSH, CPP_NORMAL

Constructor Summary

Constructors

Constructor	Description
BaseProgressReport()

Method Summary

Modifier and Type	Method	Description
protected void	clearChangeFlags()
protected void	considerReport(int flag)
void	description(java.lang.String description)
protected abstract void	doReport(int flag)
protected void	finalize()
java.lang.String	getDescription()
long	getPosition()
long	getTotal()
ProgressUnit	getUnits()
void	increment()
void	increment(long amount)
void	increment(long amount, int flag)
void	position(long position)
void	position(long position, int flag)
void	total(long total)
void	units(ProgressUnit units)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.perforce.p4java.client.IProgressReport

isComplete

Field Detail

descriptionChanged

protected boolean descriptionChanged

unitsChanged

protected boolean unitsChanged

totalChanged

protected boolean totalChanged

positionChanged

protected boolean positionChanged

isNewProgress

protected boolean isNewProgress

description

protected java.lang.String description

units

protected ProgressUnit units

total

protected long total

position

protected long position

needFinal

protected boolean needFinal

lastUpdateTime

protected long lastUpdateTime

Constructor Detail

BaseProgressReport

public BaseProgressReport()

Method Detail

description

public void description(java.lang.String description)

Specified by:

description in interface IProgressReport

units

public void units(ProgressUnit units)

Specified by:

units in interface IProgressReport

total

public void total(long total)

Specified by:

total in interface IProgressReport

position

public void position(long position)

Specified by:

position in interface IProgressReport

position

public void position(long position,
                     int flag)

Specified by:

position in interface IProgressReport

increment

public void increment()

Specified by:

increment in interface IProgressReport

increment

public void increment(long amount)

Specified by:

increment in interface IProgressReport

increment

public void increment(long amount,
                      int flag)

Specified by:

increment in interface IProgressReport

getPosition

public long getPosition()

Specified by:

getPosition in interface IProgressReport

getTotal

public long getTotal()

Specified by:

getTotal in interface IProgressReport

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface IProgressReport

getUnits

public ProgressUnit getUnits()

Specified by:

getUnits in interface IProgressReport

considerReport

protected void considerReport(int flag)

clearChangeFlags

protected void clearChangeFlags()

doReport

protected abstract void doReport(int flag)

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable