com.guiseframework.platform
Class AbstractPlatformFile

java.lang.Object
  com.guiseframework.platform.AbstractPlatformFile

All Implemented Interfaces:

ProgressListenable<java.lang.Long>, PlatformFile

Direct Known Subclasses:

WebPlatformFile

public abstract class AbstractPlatformFile
extends java.lang.Object
implements PlatformFile

An abstract implementation of a local file on a platform.

Author:

Garret Wilson

Constructor Summary

AbstractPlatformFile(java.lang.String name, long size)
Name and size constructor.

Method Summary

void	addProgressListener(ProgressListener<java.lang.Long> progressListener) Adds a progress listener.
protected void	fireProgressed(ProgressEvent<java.lang.Long> progressEvent) Fires a given progress event to all registered progress listeners.
protected void	fireProgressed(com.globalmentor.model.TaskState state, long transferred, long total) Fires a progress event to all registered progress listeners.
protected com.globalmentor.event.EventListenerManager	getEventListenerManager()
java.lang.String	getName()
long	getSize()
void	removeProgressListener(ProgressListener<java.lang.Long> progressListener) Removes an progress listener.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.guiseframework.platform.PlatformFile

cancel, upload

Constructor Detail

AbstractPlatformFile

public AbstractPlatformFile(java.lang.String name,
                            long size)

Name and size constructor.

Parameters:

name - The name of the file.

size - The size of the file, or -1 if the size is unknown.

Throws:

java.lang.NullPointerException - if the given name is null.

Method Detail

getEventListenerManager

protected com.globalmentor.event.EventListenerManager getEventListenerManager()

Returns:

The object managing event listeners.

getName

public java.lang.String getName()

Specified by:

getName in interface PlatformFile

Returns:

The name of the file.

getSize

public long getSize()

Specified by:

getSize in interface PlatformFile

Returns:

The size of the file, or -1 if the size is unknown.

addProgressListener

public void addProgressListener(ProgressListener<java.lang.Long> progressListener)

Adds a progress listener.

Specified by:

addProgressListener in interface ProgressListenable<java.lang.Long>

Parameters:

progressListener - The progress listener to add.

removeProgressListener

public void removeProgressListener(ProgressListener<java.lang.Long> progressListener)

Removes an progress listener.

Specified by:

removeProgressListener in interface ProgressListenable<java.lang.Long>

Parameters:

progressListener - The progress listener to remove.

fireProgressed

protected void fireProgressed(com.globalmentor.model.TaskState state,
                              long transferred,
                              long total)

Fires a progress event to all registered progress listeners. This method delegates to #fireProgessed(ProgressEvent).

Parameters:

state - The state of the progress.

transferred - The current number of bytes transferred, or -1 if not known.

total - The total or estimated total bytes to transfer, or -1 if not known.

Throws:

java.lang.NullPointerException - if the given state is null.

See Also:

ProgressListener, ProgressEvent

fireProgressed

protected void fireProgressed(ProgressEvent<java.lang.Long> progressEvent)

Fires a given progress event to all registered progress listeners.

Parameters:

progressEvent - The progress event to fire.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this platform file.