Package wt.eff.format

Class EffFormatDetails

java.lang.Object
wt.eff.format.EffFormatDetails
All Implemented Interfaces:
Serializable
public final class EffFormatDetails extends Object implements Serializable
A class that is designed to hold the details of a particular format as specified in the configuration resource used (defaults to a windchill preference). These include the effectivity format and the mapped parameters of interest to the format.

Instances of EffFormatDetails are designed and treated as immutable, once initialized during construction (where the class invariant is established). Hence they can be safely shared and are thread-safe. Instances of this class are not supported for using as keys in hash based data structures.


Supported API: true

Extendable: false
Since:
Windchill 9.0
See Also:

  • Field Details

    • format

      public final EffFormat format
      An EffFormat instance.

      Supported API: true

    • formatParams

      public final Map<String,String> formatParams
      Holds parameters of interest to the format. If no paramters exist, holds an empty map instead of a null reference.

      Supported API: true

  • Constructor Details

    • EffFormatDetails

      public EffFormatDetails(EffFormat format, Map<String,String> formatParams)
      Constructs instances of this class.

      Supported API: true
      Parameters:
      format - (Required) An EffFormat instance.
      formatParams - (Optional) parameters of interest to the format.

  • Method Details

    • getFormat

      public final EffFormat getFormat()
      Gets the value of the attribute: format; An EffFormat instance.

      Supported API: true
      Returns:
      EffFormat

    • getFormatParams

      public final Map<String,String> getFormatParams()
      Gets the value of the attribute: formatParams; Holds parameters of interest to the format. If no paramters exist, holds an empty map instead of a null reference.

      Supported API: true
      Returns:
      Mapinvalid input: '<'String,String>