sun.net

Class ProgressSource

java.lang.Object

sun.net.ProgressSource

All Implemented Interfaces:

Cloneable

public class ProgressSource
extends Object
implements Cloneable

ProgressSource represents the source of progress changes.

Author:

Stanley Man-Kit Ho

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProgressSource.State

Constructor Summary

Constructors

Constructor and Description
ProgressSource(URL url, String method) Construct progress source object.
ProgressSource(URL url, String method, long expected) Construct progress source object.

Method Summary

Modifier and Type	Method and Description
void	beginTracking() Begin progress tracking.
Object	clone() Creates and returns a copy of this object.
void	close() Close progress source.
boolean	connected()
void	finishTracking() Finish progress tracking.
String	getContentType() Return content type of URL.
long	getExpected() Return expected maximum progress; -1 if expected is unknown.
String	getMethod() Return method of URL.
long	getProgress() Return current progress.
ProgressSource.State	getState() Return state.
URL	getURL() Return URL of progress source.
void	setContentType(String ct)
String	toString() Returns a string representation of the object.
void	updateProgress(long latestProgress, long expectedProgress) Update progress.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressSource

public ProgressSource(URL url,
                      String method)

Construct progress source object.

ProgressSource

public ProgressSource(URL url,
                      String method,
                      long expected)

Construct progress source object.

Method Detail

beginTracking

public void beginTracking()

Begin progress tracking.

clone

public Object clone()
             throws CloneNotSupportedException

Description copied from class: Object

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x
 

will be true, and that the expression:

 x.clone().getClass() == x.getClass()
 

will be true, but these are not absolute requirements. While it is typically the case that:

 x.clone().equals(x)
 

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

The method clone for class Object performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown. Note that all arrays are considered to implement the interface Cloneable and that the return type of the clone method of an array type T[] is T[] where T is any reference or primitive type. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.

The class Object does not itself implement the interface Cloneable, so calling the clone method on an object whose class is Object will result in throwing an exception at run time.

Overrides:

clone in class Object

Returns:

a clone of this instance.

Throws:

CloneNotSupportedException - if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

See Also:

Cloneable

close

public void close()

Close progress source.

connected

public boolean connected()

finishTracking

public void finishTracking()

Finish progress tracking.

getContentType

public String getContentType()

Return content type of URL.

getExpected

public long getExpected()

Return expected maximum progress; -1 if expected is unknown.

getMethod

public String getMethod()

Return method of URL.

getProgress

public long getProgress()

Return current progress.

getState

public ProgressSource.State getState()

Return state.

getURL

public URL getURL()

Return URL of progress source.

setContentType

public void setContentType(String ct)

toString

public String toString()

Description copied from class: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.

updateProgress

public void updateProgress(long latestProgress,
                           long expectedProgress)

Update progress.