com.dynalivery.repository.util
Class FolderRef

java.lang.Object
  |
  +--com.dynalivery.repository.util.RepositoryRef
        |
        +--com.dynalivery.repository.util.FolderRef

public class FolderRef
extends RepositoryRef
implements java.io.Serializable, java.util.Comparator

This class is used to uniquely identify a repository folder

See Also:
Serialized Form

Constructor Summary
FolderRef(java.lang.String pathname)
          Public constructor for a repository folder reference using pathname
FolderRef(java.lang.String folderKey, java.lang.String folderName)
          Public constructor for a repository folder reference using folder key
 
Method Summary
 int compare(java.lang.Object o1, java.lang.Object o2)
          Compares its two arguments for order.
 int compareTo(java.lang.Object anotherObject)
          Compares this object with the specified object for order.
 boolean equals(java.lang.Object anotherObject)
          Compares two objects for equality
 java.lang.String getFolderKey()
          get the repository folder key String for this folder
 java.lang.String getFolderName()
          get the repository name String for this folder
 java.lang.String getPathname()
          get the repository pathname String for this folder
 void setFolderKey(java.lang.String folderKey)
          set the repository folder key String for this folder
 void setFolderName(java.lang.String folderName)
          set the repository name String for this folder
 void setPathname(java.lang.String pathname)
          set the repository pathname String for this folder
 java.lang.String toString()
          Returns a String which describes this repository file reference.
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FolderRef

public FolderRef(java.lang.String pathname)
Public constructor for a repository folder reference using pathname
Parameters:
pathname - the repository pathname String

FolderRef

public FolderRef(java.lang.String folderKey,
                 java.lang.String folderName)
Public constructor for a repository folder reference using folder key
Parameters:
key - the repository folder key String
name - the folder name
Method Detail

getPathname

public java.lang.String getPathname()
get the repository pathname String for this folder
Overrides:
getPathname in class RepositoryRef
Returns:
the repository pathname String for this folder

setPathname

public void setPathname(java.lang.String pathname)
set the repository pathname String for this folder
Returns:
the repository pathname String for this folder

getFolderName

public java.lang.String getFolderName()
get the repository name String for this folder
Returns:
the repository name String for this folder

setFolderName

public void setFolderName(java.lang.String folderName)
set the repository name String for this folder
Returns:
the repository name String for this folder

getFolderKey

public java.lang.String getFolderKey()
get the repository folder key String for this folder
Returns:
the repository folder key String for this folder

setFolderKey

public void setFolderKey(java.lang.String folderKey)
set the repository folder key String for this folder
Parameters:
key - the repository folder key String for this folder

compare

public int compare(java.lang.Object o1,
                   java.lang.Object o2)
Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.
Specified by:
compare in interface java.util.Comparator
Overrides:
compare in class RepositoryRef
Returns:
a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second

compareTo

public int compareTo(java.lang.Object anotherObject)
Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
Overrides:
compareTo in class RepositoryRef
Parameters:
anotherObject - the object to compare to this one
Returns:
a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

equals

public boolean equals(java.lang.Object anotherObject)
Compares two objects for equality
Specified by:
equals in interface java.util.Comparator
Overrides:
equals in class RepositoryRef
Parameters:
anotherObject - the object to compare to this one
Returns:
true if the objects are equal

toString

public java.lang.String toString()
Returns a String which describes this repository file reference.
Overrides:
toString in class RepositoryRef
Returns:
a String which describes this repository file reference.