org.apache.excalibur.source.impl.validity
Class FileTimeStampValidity

java.lang.Object
  org.apache.excalibur.source.impl.validity.FileTimeStampValidity

All Implemented Interfaces:

java.io.Serializable, SourceValidity

public final class FileTimeStampValidity

extends java.lang.Object

implements SourceValidity

A validation object for time-stamps.

Version:

CVS $Revision: 1.4 $

Author:

Avalon Development Team

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.excalibur.source.SourceValidity

INVALID, UNKNOWN, UNKNWON, VALID

Constructor Summary

FileTimeStampValidity(java.io.File file)

FileTimeStampValidity(java.io.File file, long timeStamp)

FileTimeStampValidity(java.lang.String filename)

Method Summary

java.io.File	getFile()
long	getTimeStamp()
int	isValid() Check if the component is still valid.
int	isValid(SourceValidity newValidity) Check if the component is still valid.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FileTimeStampValidity

public FileTimeStampValidity(java.lang.String filename)

FileTimeStampValidity

public FileTimeStampValidity(java.io.File file)

FileTimeStampValidity

public FileTimeStampValidity(java.io.File file,
                             long timeStamp)

Method Detail

isValid

public int isValid()

Check if the component is still valid. If 0 is returned the isValid(SourceValidity) must be called afterwards! If -1 is returned, the component is not valid anymore and if +1 is returnd, the component is valid.

Specified by:

isValid in interface SourceValidity

isValid

public int isValid(SourceValidity newValidity)

Description copied from interface: SourceValidity

Check if the component is still valid. This is only true if the incoming Validity is of the same type and has the "same" values.

The invocation order is that the isValid method of the old Validity object is called with the new one as a parameter.

Specified by:

isValid in interface SourceValidity

Returns:

-1 is returned, if the validity object is not valid anymore +1 is returned, if the validity object is still valid 0 is returned, if the validity check could not be performed. In this case, the new validity object is not usable. Examples for this are: when the validity objects have different types, or when one validity object for any reason is not able to get the required information.

getFile

public java.io.File getFile()

getTimeStamp

public long getTimeStamp()

toString

public java.lang.String toString()