com.eteks.sweethome3d.io

Enum ContentRecording

java.lang.Object

java.lang.Enum<ContentRecording>

com.eteks.sweethome3d.io.ContentRecording

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ContentRecording>

public enum ContentRecording
extends java.lang.Enum<ContentRecording>

Describes how content associated to a home should be managed during recording.

Author:

Emmanuel Puybaret

Enum Constant Summary

Enum Constants

Enum Constant and Description
INCLUDE_ALL_CONTENT Include all content objects referenced by a Home instance.
INCLUDE_NO_CONTENT Include no content instance referenced by a Home instance.
INCLUDE_TEMPORARY_CONTENT Include content instances of TemporaryURLContent class referenced by a Home instance as well as the content already saved with it.

Method Summary

Modifier and Type	Method and Description
static ContentRecording	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ContentRecording[]	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

INCLUDE_ALL_CONTENT

public static final ContentRecording INCLUDE_ALL_CONTENT

Include all content objects referenced by a Home instance.

INCLUDE_TEMPORARY_CONTENT

public static final ContentRecording INCLUDE_TEMPORARY_CONTENT

Include content instances of TemporaryURLContent class referenced by a Home instance as well as the content already saved with it.

INCLUDE_NO_CONTENT

public static final ContentRecording INCLUDE_NO_CONTENT

Include no content instance referenced by a Home instance. This should be used only if all the content objects reference external data which is always available (with an URL for example).

Method Detail

values

public static ContentRecording[] 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 (ContentRecording c : ContentRecording.values())
    System.out.println(c);

Returns:

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

valueOf

public static ContentRecording 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