Top Description Fields Constructors Methods
com.sun.faces.application.resource

public Class LibraryInfo

extends Object
Class Inheritance
Known Direct Subclasses
com.sun.faces.application.resource.FaceletLibraryInfo

LibraryInfo is a simple wrapper class for information pertinent to building a complete resource path using a Library and/or Contract.

Field Summary

Modifier and TypeField and Description
private String
private final ResourceHelper
private String
private final String
private String
private String
private final VersionInfo

Constructor Summary

AccessConstructor and Description
pack-priv
LibraryInfo(String
the name of the library
name
,
VersionInfo
the version of the library, if any
version
,
String localePrefix, String contract, ResourceHelper
the helper class for this resource
helper
)

Constructs a new LibraryInfo using the specified details.

pack-priv
LibraryInfo(LibraryInfo other, boolean copyLocalePrefix)

Method Summary

Modifier and TypeMethod and Description
private void
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public String

Returns:

active contract or null
getContract
()

public ResourceHelper

Returns:

return the ResourceHelper for this resource
getHelper
()

public String

Returns:

the Locale prefix, if any.
getLocalePrefix
()

public String

Returns:

return the library name.
getName
()

public String

Returns:

the base path of the library.
getPath
()

public String
getPath(String localePrefix)

public VersionInfo

Returns:

return the version of the library, or null if the library isn't versioned.
getVersion
()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

private void
initPath()

Construct the full path to the base directory of the library's resources.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

contractback to summary
private String contract
helperback to summary
private final ResourceHelper helper
localePrefixback to summary
private String localePrefix
nameback to summary
private final String name
nonLocalizedPathback to summary
private String nonLocalizedPath
pathback to summary
private String path
versionback to summary
private final VersionInfo version

Constructor Detail

LibraryInfoback to summary
pack-priv LibraryInfo(String name, VersionInfo version, String localePrefix, String contract, ResourceHelper helper)

Constructs a new LibraryInfo using the specified details.

Parameters
name:String

the name of the library

version:VersionInfo

the version of the library, if any

helper:ResourceHelper

the helper class for this resource

LibraryInfoback to summary
pack-priv LibraryInfo(LibraryInfo other, boolean copyLocalePrefix)

Method Detail

appendBasePathback to summary
private void appendBasePath(StringBuilder builder)
equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getContractback to summary
public String getContract()
Returns:String

active contract or null

getHelperback to summary
public ResourceHelper getHelper()
Returns:ResourceHelper

return the ResourceHelper for this resource

getLocalePrefixback to summary
public String getLocalePrefix()
Returns:String

the Locale prefix, if any.

getNameback to summary
public String getName()
Returns:String

return the library name.

getPathback to summary
public String getPath()
Returns:String

the base path of the library.

getPathback to summary
public String getPath(String localePrefix)
getVersionback to summary
public VersionInfo getVersion()
Returns:VersionInfo

return the version of the library, or null if the library isn't versioned.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
initPathback to summary
private void initPath()

Construct the full path to the base directory of the library's resources.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override