gov.nasa.pds.label
Enum ProductType

java.lang.Object
  extended by java.lang.Enum<ProductType>
      extended by gov.nasa.pds.label.ProductType
All Implemented Interfaces:
Serializable, Comparable<ProductType>

public enum ProductType
extends Enum<ProductType>

Defines label product types, as enumeration constants. Not all PDS product types are distinguished by the object-access library. The value PRODUCT_OTHER is used for all products not specially handled by the library.


Enum Constant Summary
PRODUCT_BROWSE
          A PDS4 browse product.
PRODUCT_BUNDLE
          A PDS4 bundle product.
PRODUCT_COLLECTION
          A PDS4 collection product.
PRODUCT_DOCUMENT
          A PDS4 document product.
PRODUCT_OBSERVATIONAL
          A PDS4 observational product.
PRODUCT_OTHER
          Another product type not specifically handled by the object access library.
PRODUCT_PDS3
          A PDS 3 version generic product.
PRODUCT_THUMBNAIL
          A PDS4 thumbnail product.
 
Method Summary
static ProductType typeForClass(Class<? extends Product> clazz)
          Gets the product type for a PDS4 product class.
static ProductType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ProductType[] 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

PRODUCT_PDS3

public static final ProductType PRODUCT_PDS3
A PDS 3 version generic product.


PRODUCT_OBSERVATIONAL

public static final ProductType PRODUCT_OBSERVATIONAL
A PDS4 observational product.


PRODUCT_BROWSE

public static final ProductType PRODUCT_BROWSE
A PDS4 browse product.


PRODUCT_THUMBNAIL

public static final ProductType PRODUCT_THUMBNAIL
A PDS4 thumbnail product.


PRODUCT_DOCUMENT

public static final ProductType PRODUCT_DOCUMENT
A PDS4 document product.


PRODUCT_BUNDLE

public static final ProductType PRODUCT_BUNDLE
A PDS4 bundle product.


PRODUCT_COLLECTION

public static final ProductType PRODUCT_COLLECTION
A PDS4 collection product.


PRODUCT_OTHER

public static final ProductType PRODUCT_OTHER
Another product type not specifically handled by the object access library.

Method Detail

values

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

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

valueOf

public static ProductType valueOf(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:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

typeForClass

public static ProductType typeForClass(Class<? extends Product> clazz)
Gets the product type for a PDS4 product class.

Parameters:
clazz - the product class
Returns:
the product type enumeration constant for that product class


Copyright © 2014. All Rights Reserved.