Class: AttributeList

AttributeList

This class represents a list for Attribute.

new AttributeList()

Extends

Requires

  • module:Attribute~Attribute

Methods

Clears this list.

Creates a clone of the current list.

Name Type Description
typeOnly Boolean
Returns:
Type Description
AttributeList

contains(attribute, typeOnly){Boolean}

Name Type Description
attribute Attribute
typeOnly Boolean nullable
Deprecated
  • Use containsTypeOf or containsValueOf instead.
    Returns:
    Type Description
    Boolean

    containsTypeOf(attribute){Boolean}

    Verifies whether an attribute with the type of the given item is included in this list.

    Name Type Description
    attribute Attribute

    AttributeType that should be verified.

    Returns:
    Type Description
    Boolean

    containsValueOf(attribute){Boolean}

    Verifies whether the given item is included in the list.

    Name Type Description
    attribute Attribute

    AttributeValue that should be verified.

    Returns:
    Type Description
    Boolean

    equals(attributeList, typeOnly){Boolean}

    Name Type Description
    attributeList AttributeList
    typeOnly Boolean
    Deprecated
    • Use equalsTypesIn or equalsValuesIn instead.
      Returns:
      Type Description
      Boolean

      equalsTypesIn(attributeList){boolean}

      Compare the specified AttributeList with this instance.

      Name Type Description
      attributeList AttributeList

      AttributeList that should be compared.

      Returns:
      Type Description
      boolean

      equalsValuesIn(attributeList){boolean}

      Compare the specified AttributeList with this instance.

      Name Type Description
      attributeList AttributeList

      AttributeList that should be compared.

      Returns:
      Type Description
      boolean

      getAttributesWithInputParameters(){AttributeList}

      Returns:
      Type Description
      AttributeList

      getAttributeWithTypeOf(attribute){Attribute}

      Name Type Description
      attribute Attribute
      Returns:
      Type Description
      Attribute

      Returns the item for the specified key.

      Name Type Description
      key string

      key that should be searched for

      Returns:
      Type Description
      *

      inherited abstractgetItems(){Array}

      Returns all items.

      Returns:
      Type Description
      Array

      inherited getKeys(){Array}

      Returns the keys of all items.

      Returns:
      Type Description
      Array

      Returns only this values that matches to the given type.

      Name Type Description
      attributeList AttributeList | Array

      Attributes that should be returned.

      Returns:
      Type Description
      AttributeList

      getSubsetWithoutItems(attributeList){AttributeList}

      Returns a subset without the given types.

      Name Type Description
      attributeList AttributeList | Array

      AttributeTypes that should not be included

      Returns:
      Type Description
      AttributeList

      getValueForAttributeWithTypeOf(attribute){Attribute}

      Returns the attribute value that matches the provided attribute type.

      Name Type Description
      attribute AttributeType
      Returns:
      Type Description
      Attribute

      hasAttributesWithInputParameters(){boolean}

      Returns:
      Type Description
      boolean

      inherited isEmpty(){boolean}

      Verifies whether the list is empty.

      Returns:
      Type Description
      boolean

      put(attribute, multipleInstances)

      Adds the specified item to the itemList.

      Name Type Description
      attribute Attribute

      AttributeType

      multipleInstances boolean

      putAll(attributeList)

      Adds all items in the specified list to the itemList.

      Name Type Description
      attributeList AttributeList | Array

      AttributeList

      removeAttributeWithTypeOf(attribute, allOccurrences)

      Name Type Description
      attribute Attribute
      allOccurrences Boolean

      Removes the item from this list for the specified key.

      Name Type Description
      key string

      key that should be searched for

      Returns the number of items that are included.

      Returns:
      Type Description
      Number

      updateValue(attribute)

      Name Type Description
      attribute Attribute

      inherited withItems(list){*}

      Builder for Item list.

      Name Type Description
      list *
      Returns:
      Type Description
      *