Class AbsContentElementList

    • Constructor Detail

      • AbsContentElementList

        public AbsContentElementList()
        Construct an Abstract descriptor to hold a content element list
    • Method Detail

      • add

        public void add​(AbsContentElement element)
        Add a new element (that must be a content element) to this content element list.
        Parameters:
        element - The element to add.
      • size

        public int size()
        Retrieves the number of elements in this content element list.
        Returns:
        The number of elements.
      • get

        public AbsContentElement get​(int i)
        Retrieves the i-th element in this content element list.
        Parameters:
        i - The index of the element to retrieve.
        Returns:
        The element.
      • iterator

        public Iterator iterator()
        Returns:
        An Iterator over the elements of this content element list.
      • clear

        public void clear()
        Clear all the elements in this content element list.
      • contains

        public boolean contains​(AbsContentElement element)
        Test if a given content element is contained in this content element list.
        Returns:
        true if the given content element is contained in this content element list.
      • indexOf

        public int indexOf​(AbsContentElement element)
        Returns the position of an element within this content element list.
        Returns:
        The position of an element within this content element list or -1 if the given element is not contained in this content element list.
      • remove

        public AbsContentElement remove​(int index)
        Removes the element at the given position from this content element list.
        Returns:
        The removed element.
      • isEmpty

        public boolean isEmpty()
        Test if the content element list is empty.
        Returns:
        true if this content element list does not contain any element.
      • toArray

        public AbsContentElement[] toArray()
        Retrieve all elements in this content element list in the form of an array.
        Returns:
        An array containing all elements in this content element list.
      • getAbsObject

        public AbsObject getAbsObject​(String name)
        Makes no sense in the case of an AbsContentElementList that has no attribute --> Just return null
        Specified by:
        getAbsObject in interface AbsObject
        Parameters:
        name - The name of the attribute.
        Returns:
        value The value of the attribute.
      • getNames

        public String[] getNames()
        Makes no sense in the case of an AbsContentElementList that has no attribute --> Just return null
        Specified by:
        getNames in interface AbsObject
        Returns:
        the name of all attributes.
      • isGrounded

        public boolean isGrounded()
        Tests if this AbsContentElementList is grounded, i.e., if no one of its elements is associated with a variable
        Specified by:
        isGrounded in interface AbsObject
        Returns:
        true if the object is grounded.
      • getCount

        public int getCount()
        Return the number of elements in the list. Is equivalent to size()
        Specified by:
        getCount in interface AbsObject
        Returns:
        the number of attributes.
      • toString

        public String toString()
        This method is here just for debugging. Notice that it is highly innefficient. The method StringCodec.encode() should be used instead.
        Overrides:
        toString in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • isAContentExpression

        public boolean isAContentExpression()
        Description copied from interface: AbsContentElement
        Return true if this Abstract Content Element represents a ContentExpression of the SL Grammar (see also FIPA-SL specifications).
        Specified by:
        isAContentExpression in interface AbsContentElement
        Returns:
        true if this Abstract Content Element represents a ContentExpression of the SL Grammar (see also FIPA-SL specifications), false otherwise
        See Also:
        AbsContent.isAContentExpression
      • setIsAContentExpression

        public void setIsAContentExpression​(boolean flag)
        Description copied from interface: AbsContentElement
        Set the isAContentExpression flag to the passed value. By default, if this method was not called, this value is intialized to false.
        Specified by:
        setIsAContentExpression in interface AbsContentElement
        Parameters:
        flag - true if this Abstract Content Element represents a ContentExpression of the SL Grammar (see also FIPA-SL specifications), false otherwise