Eclipse
Eclipse
IDEA
IntelliJ
NetBeans
NetBeans
XpoLog
XpoLog
org.apache.hivemind
Interface Resource
Tab mode
public interface Resource
Describes the location of a resource, such as a module deployment descriptor, or a messages file.

Resources may be either base or localized. A localized version of a base resource may be obtained via getLocalization(Locale) .

Resource locations are used as Map keys, they must implement hashCode() and equals(Object) properly.

Resource locations are valid even if the corresponding resource doesn't exist. To verify if a localization actually exists, use getResourceURL() , which returns null if the resource doesn't exist. getLocalization(Locale) returns only real resource locations, where the resource exists.

Folders must be represented with a trailing slash.

SinceNot specified.
VersionNot specified.
AuthorHoward Lewis Ship
Wiki javadoc Use textile entry format.
Add your comments here.
Method Summary
Locale getLocale()
Returns the locale for which this resource has been localized or null if the resource has not been localized.
Resource getLocalization( Locale locale )
Returns a localized version of this resource (or this resource, if no appropriate localization is found).
String getName()
Returns the file name portion of the resource location.
String getPath()
Returns the path that represents the resource.
Resource getRelativeResource( String name )
Returns at a relative location to this resource.
URL getResourceURL()
Returns a URL for the resource.
Method Detail
getLocale
public Locale getLocale ( )
Returns the locale for which this resource has been localized or null if the resource has not been localized. This should only be used when the type of resource is known. This locale is the same or more general than the locale for which localization was requested. For example, if the requested locale was en_US, but only the file Home_en was found, this locale returned would be en.
Wiki javadoc Use textile entry format.
Add your comments here.
getLocalization
public Resource getLocalization ( Locale locale )
Returns a localized version of this resource (or this resource, if no appropriate localization is found). Should only be invoked on a base resource.
Parameters
TypeNameDescription
Locale locale to localize for, or null for no localization.
Wiki javadoc Use textile entry format.
Add your comments here.
getName
public String getName ( )
Returns the file name portion of the resource location.
Wiki javadoc Use textile entry format.
Add your comments here.
getPath
public String getPath ( )
Returns the path that represents the resource. This should only be used when the type of resource is known.
Wiki javadoc Use textile entry format.
Add your comments here.
getRelativeResource
public Resource getRelativeResource ( String name )
Returns at a relative location to this resource. The new resource may or may not exist; this can be determined via getResourceURL() .
Parameters
TypeNameDescription
String name name of new resource, possibly as a relative path, or as an absolute path (starting with a slash).
Wiki javadoc Use textile entry format.
Add your comments here.
getResourceURL
public URL getResourceURL ( )
Returns a URL for the resource.
Wiki javadoc Use textile entry format.
Add your comments here.