io.guise.framework.Resources Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of guise-framework Show documentation
Show all versions of guise-framework Show documentation
Guise™ Internet application framework.
/*
* Copyright © 2005-2013 GlobalMentor, Inc. null.
* @see ECMA-48: Control Functions for Coded Character Sets
*/
public static final String createStringResourceReference(final String resourceKey) {
return createControlString(resourceKey); //return a control string for the given resource key
}
/**
* Creates a string containing a value that can be used as an argument in formatting.
* @param value The value to be used as an argument.
* @return A string containing a reference to the given value, an ECMA-48 control string beginning with {@value #STRING_VALUE_REFERENCE_PREFIX_CHAR} with the
* given Value as its content.
* @throws NullPointerException if the given value is null.
* @see ECMA-48: Control Functions for Coded Character Sets
*/
public static final String createStringValueReference(final String value) {
return createControlString(new StringBuilder().append(STRING_VALUE_REFERENCE_PREFIX_CHAR).append(value).toString()); //return a control string for the given value prefixed by the value reference character
}
/**
* Creates a URI containing a reference to the given string resource key. The URI resource reference is URI with the scheme resource and the
* scheme-specific part indicating the resource key.
* @param resourceKey The resource key to a string in the resources which could be retrieved using {@link GuiseSession#getURIResource(String)}.
* @return A URI containing a reference to the given resource key, which can be resolved using {@link GuiseSession#resolveURI(URI, String...)}.
* @throws NullPointerException if the given resource key is null.
*/
public static final URI createURIResourceReference(final String resourceKey) {
return createURI(RESOURCE_SCHEME, requireNonNull(resourceKey, "Resource key cannot be null."));
}
/**
* Returns a form of the enum name appropriate for a resource key. The name is converted to lowercaes and all underscore characters ('_') are replaced by
* periods ('.'). For example, FILE_NOT_FOUND would produce file.not.found.
* @param e The enum instance to convert to a resource key.
* @return A string representing the enum instance in a style appropriate for use as a resource key.
* @see Enum#name()
*/
public static String getResourceKeyName(final Enum e) {
return e.name().toLowerCase().replace('_', '.'); //convert the name to lowercase and replace underscores with periods
}
/**
* Returns a resource reference for the label aspect of a resource key based upon the given enum class. The resource reference will a resource key in the form
* com.example.EnumClass.label.
* @param The type of the enum.
* @param enumClass The enum class for which to return a resource reference.
* @return A string resource reference to the label aspect of a resource key based upon the given enum class.
* @throws NullPointerException if the given enum is null.
* @see Classes#getPropertyName(Class, String)
* @see #LABEL_PROPERTY_KEY_ASPECT
* @see #createStringResourceReference(String)
*/
public static > String getLabelResourceReference(final Class enumClass) {
return createStringResourceReference(Classes.getPropertyName(enumClass, LABEL_PROPERTY_KEY_ASPECT));
}
/**
* Returns a resource reference for the label aspect of a resource key based upon the given enum. The resource reference will a resource key in the form
* com.example.EnumClass.NAME.label.
* @param The type of the enum.
* @param e The enum instance for which to return a resource reference.
* @return A string resource reference to the label aspect of a resource key based upon the given enum.
* @throws NullPointerException if the given enum is null.
* @see Enums#getPropertyName(Enum, String)
* @see #LABEL_PROPERTY_KEY_ASPECT
* @see #createStringResourceReference(String)
*/
public static > String getLabelResourceReference(final E e) {
return createStringResourceReference(Enums.getPropertyName(e, LABEL_PROPERTY_KEY_ASPECT));
}
/**
* Returns a resource reference for the glyph aspect of a resource key based upon the given enum class. The resource reference will a resource key in the form
* com.example.EnumClass.glyph.
* @param The type of the enum.
* @param enumClass The enum class for which to return a resource reference.
* @return A URI resource reference to the glyph aspect of a resource key based upon the given enum class.
* @throws NullPointerException if the given enum is null.
* @see Classes#getPropertyName(Class, String)
* @see #GLYPH_PROPERTY_KEY_ASPECT
* @see #createURIResourceReference(String)
*/
public static > URI getGlyphResourceReference(final Class enumClass) {
return createURIResourceReference(Classes.getPropertyName(enumClass, GLYPH_PROPERTY_KEY_ASPECT));
}
/**
* Returns a resource reference for the glyph aspect of a resource key based upon the given enum. The resource reference will a resource key in the form
* com.example.EnumClass.NAME.glyph.
* @param The type of the enum.
* @param e The enum instance for which to return a resource reference.
* @return A URI resource reference to the glyph aspect of a resource key based upon the given enum.
* @throws NullPointerException if the given enum is null.
* @see Enums#getPropertyName(Enum, String)
* @see #GLYPH_PROPERTY_KEY_ASPECT
* @see #createURIResourceReference(String)
*/
public static > URI getGlyphResourceReference(final E e) {
return createURIResourceReference(Enums.getPropertyName(e, GLYPH_PROPERTY_KEY_ASPECT));
}
/**
* Returns a resource reference for the info aspect of a resource key based upon the given enum class. The resource reference will a resource key in the form
* com.example.EnumClass.info.
* @param The type of the enum.
* @param enumClass The enum class for which to return a resource reference.
* @return A string resource reference to the info aspect of a resource key based upon the given enum class.
* @throws NullPointerException if the given enum is null.
* @see Classes#getPropertyName(Class, String)
* @see #INFO_PROPERTY_KEY_ASPECT
* @see #createStringResourceReference(String)
*/
public static > String getInfoResourceReference(final Class enumClass) {
return createStringResourceReference(Classes.getPropertyName(enumClass, INFO_PROPERTY_KEY_ASPECT));
}
/**
* Returns a resource reference for the info aspect of a resource key based upon the given enum. The resource reference will a resource key in the form
* com.example.EnumClass.NAME.info.
* @param The type of the enum.
* @param e The enum instance for which to return a resource reference.
* @return A string resource reference to the info aspect of a resource key based upon the given enum.
* @throws NullPointerException if the given enum is null.
* @see Enums#getPropertyName(Enum, String)
* @see #INFO_PROPERTY_KEY_ASPECT
* @see #createStringResourceReference(String)
*/
public static > String getInfoResourceReference(final E e) {
return createStringResourceReference(Enums.getPropertyName(e, INFO_PROPERTY_KEY_ASPECT));
}
}