Class DataType

    • Method Detail

      • type

        public final Type type()

        The underlying type of the data type.

        If the service returns an enum value that is not available in the current SDK version, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

        Returns:
        The underlying type of the data type.
        See Also:
        Type
      • typeAsString

        public final String typeAsString()

        The underlying type of the data type.

        If the service returns an enum value that is not available in the current SDK version, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

        Returns:
        The underlying type of the data type.
        See Also:
        Type
      • nestedType

        public final DataType nestedType()

        The nested type in the data type.

        Returns:
        The nested type in the data type.
      • hasAllowedValues

        public final boolean hasAllowedValues()
        For responses, this returns true if the service returned a value for the AllowedValues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • allowedValues

        public final List<DataValue> allowedValues()

        The allowed values for this data type.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAllowedValues() method.

        Returns:
        The allowed values for this data type.
      • unitOfMeasure

        public final String unitOfMeasure()

        The unit of measure used in this data type.

        Returns:
        The unit of measure used in this data type.
      • relationship

        public final Relationship relationship()

        A relationship that associates a component with another component.

        Returns:
        A relationship that associates a component with another component.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)