Interface XmlaConstant.Dictionary<E extends java.lang.Enum<E> & XmlaConstant>

  • Enclosing interface:
    XmlaConstant

    public static interface XmlaConstant.Dictionary<E extends java.lang.Enum<E> & XmlaConstant>
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Set<E> forMask​(int xmlaOrdinalMask)
      Creates a set of values by parsing a mask.
      E forName​(java.lang.String xmlaName)
      Returns the enumeration value with the given name in the XMLA specification, or null if there is no such.
      E forOrdinal​(int xmlaOrdinal)
      Returns the enumeration value with the given ordinal in the XMLA specification, or null if there is no such.
      java.lang.Class<E> getEnumClass()
      Returns the class that the enum values belong to.
      java.util.List<E> getValues()
      Returns all values of the enum.
      int toMask​(java.util.Set<E> set)
      Converts a set of enum values to an integer by logical OR-ing their codes.
    • Method Detail

      • forOrdinal

        E forOrdinal​(int xmlaOrdinal)
        Returns the enumeration value with the given ordinal in the XMLA specification, or null if there is no such.
        Parameters:
        xmlaOrdinal - XMLA ordinal
        Returns:
        Enumeration value
      • forName

        E forName​(java.lang.String xmlaName)
        Returns the enumeration value with the given name in the XMLA specification, or null if there is no such.
        Parameters:
        xmlaName - XMLA name
        Returns:
        Enumeration value
      • forMask

        java.util.Set<E> forMask​(int xmlaOrdinalMask)
        Creates a set of values by parsing a mask.
        Parameters:
        xmlaOrdinalMask - Bit mask
        Returns:
        Set of E values
      • toMask

        int toMask​(java.util.Set<E> set)
        Converts a set of enum values to an integer by logical OR-ing their codes.
        Parameters:
        set - Set of enum values
        Returns:
        Bitmap representing set of enum values
      • getValues

        java.util.List<E> getValues()
        Returns all values of the enum.

        This method may be more efficient than Class.getEnumConstants() because the latter is required to create a new array every call to prevent corruption.

        Returns:
        List of enum values
      • getEnumClass

        java.lang.Class<E> getEnumClass()
        Returns the class that the enum values belong to.
        Returns:
        enum class