com.eteks.sweethome3d.io

Enum DefaultTexturesCatalog.PropertyKey

java.lang.Object

java.lang.Enum<DefaultTexturesCatalog.PropertyKey>

com.eteks.sweethome3d.io.DefaultTexturesCatalog.PropertyKey

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DefaultTexturesCatalog.PropertyKey>

Enclosing class:

DefaultTexturesCatalog

public static enum DefaultTexturesCatalog.PropertyKey
extends java.lang.Enum<DefaultTexturesCatalog.PropertyKey>

The keys of the properties values read in .properties files.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CATEGORY The key for the category's name of a texture (mandatory).
CREATOR The key for the creator of a texture (optional).
HEIGHT The key for the height in centimeters of a texture (mandatory).
ID The key for the ID of a texture (optional).
IMAGE The key for the image file of a texture (mandatory).
IMAGE_DIGEST The key for the SHA-1 digest of the image file of a texture (optional).
NAME The key for the name of a texture (mandatory).
WIDTH The key for the width in centimeters of a texture (mandatory).

Method Summary

Modifier and Type	Method and Description
java.lang.String	getKey(int textureIndex) Returns the key for the texture property of the given index.
static DefaultTexturesCatalog.PropertyKey	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DefaultTexturesCatalog.PropertyKey[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ID

public static final DefaultTexturesCatalog.PropertyKey ID

The key for the ID of a texture (optional). Two textures read in a texture catalog can't have the same ID and the second one will be ignored.

NAME

public static final DefaultTexturesCatalog.PropertyKey NAME

The key for the name of a texture (mandatory).

CATEGORY

public static final DefaultTexturesCatalog.PropertyKey CATEGORY

The key for the category's name of a texture (mandatory). A new category with this name will be created if it doesn't exist.

IMAGE

public static final DefaultTexturesCatalog.PropertyKey IMAGE

The key for the image file of a texture (mandatory). This image file can be either the path to an image relative to classpath or an absolute URL. It should be encoded in application/x-www-form-urlencoded format if needed.

IMAGE_DIGEST

public static final DefaultTexturesCatalog.PropertyKey IMAGE_DIGEST

The key for the SHA-1 digest of the image file of a texture (optional). This property is used to compare faster catalog resources with the ones of a read home, and should be encoded in Base64.

WIDTH

public static final DefaultTexturesCatalog.PropertyKey WIDTH

The key for the width in centimeters of a texture (mandatory).

HEIGHT

public static final DefaultTexturesCatalog.PropertyKey HEIGHT

The key for the height in centimeters of a texture (mandatory).

CREATOR

public static final DefaultTexturesCatalog.PropertyKey CREATOR

The key for the creator of a texture (optional).

Method Detail

values

public static DefaultTexturesCatalog.PropertyKey[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DefaultTexturesCatalog.PropertyKey c : DefaultTexturesCatalog.PropertyKey.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DefaultTexturesCatalog.PropertyKey valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getKey

public java.lang.String getKey(int textureIndex)

Returns the key for the texture property of the given index.