Package org.magicwerk.brownies.collections

Class IList.IReadOnlyList<E>

    • Constructor Detail

      • IReadOnlyList

        protected IReadOnlyList()

    • Method Detail

      • unmodifiableList

        public IList<E> unmodifiableList()
        Description copied from class: IList
        Returns an unmodifiable view of this list. This method allows modules to provide users with "read-only" access to internal lists. Query operations on the returned list "read through" to the specified list, and attempts to modify the returned list, whether direct or via its iterator, result in an UnsupportedOperationException. If this list is already unmodifiable, it is returned unchanged.
        Specified by:
        unmodifiableList in class IList<E>
        Returns:
        an unmodifiable view of the specified list

      • doClone

        protected void doClone​(IList<E> that)
        Description copied from class: IList
        Initialize this object after the bitwise copy has been made by Object.clone().
        Specified by:
        doClone in class IList<E>
        Parameters:
        that - source object

      • capacity

        public int capacity()
        Description copied from class: IList
        Returns capacity of this list. Note that two lists are considered equal even if they have a distinct capacity. Also the capacity can be changed by operations like clone() etc.
        Specified by:
        capacity in class IList<E>
        Returns:
        capacity of this list

      • doSet

        protected E doSet​(int index,
                  E elem)
        Description copied from class: IList
        Helper method for setting an element in the list. This is the only method which really sets an element. Override if you need to validity checks before setting.
        Specified by:
        doSet in class IList<E>
        Parameters:
        index - index where element will be placed
        elem - element to set
        Returns:
        old element which was at the position

      • doReSet

        protected E doReSet​(int index,
                    E elem)
        Description copied from class: IList
        Sets an element at specified position. This method is used internally if existing elements will be moved etc. Override if you need to validity checks.
        Specified by:
        doReSet in class IList<E>
        Parameters:
        index - index where element will be placed
        elem - element to set
        Returns:
        old element which was at the position

      • doAdd

        protected boolean doAdd​(int index,
                        E elem)
        Description copied from class: IList
        Helper method for adding an element to the list. This is the only method which really adds an element. Override if you need to validity checks before adding.
        Specified by:
        doAdd in class IList<E>
        Parameters:
        index - index where element should be added (-1 means it is up to the implementation to choose the index)
        elem - element to add
        Returns:
        true if element has been added, false otherwise

      • doRemove

        protected E doRemove​(int index)
        Description copied from class: IList
        Helper method to remove an element. This is the only method which really removes an element. Override if you need to validity checks before removing.
        Specified by:
        doRemove in class IList<E>
        Parameters:
        index - index of element to remove
        Returns:
        removed element

      • doEnsureCapacity

        protected void doEnsureCapacity​(int minCapacity)
        Description copied from class: IList
        Increases the capacity of this list instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
        Specified by:
        doEnsureCapacity in class IList<E>
        Parameters:
        minCapacity - the desired minimum capacity

      • trimToSize

        public void trimToSize()
        Description copied from class: IList
        An application can use this operation to minimize the storage of an instance.
        Specified by:
        trimToSize in class IList<E>

      • doCreate

        protected IList<E> doCreate​(int capacity)
        Description copied from class: IList
        Create list with specified capacity.
        Specified by:
        doCreate in class IList<E>
        Parameters:
        capacity - initial capacity (use -1 for default capacity)
        Returns:
        created list

      • doAssign

        protected void doAssign​(IList<E> that)
        Description copied from class: IList
        Assign this list the content of the that list. This is done by bitwise copying so the that list should not be used afterwards.
        Specified by:
        doAssign in class IList<E>
        Parameters:
        that - list to copy content from

      • sort

        public void sort​(int index,
                 int len,
                 java.util.Comparator<? super E> comparator)
        Description copied from class: IList
        Sort specified elements in the list using the specified comparator.
        Specified by:
        sort in class IList<E>
        Parameters:
        index - index of first element to sort
        len - number of elements to sort
        comparator - comparator to use for sorting (null means the elements natural ordering should be used)
        See Also:
        Arrays.sort(int[])

      • binarySearch

        public <K> int binarySearch​(int index,
                            int len,
                            K key,
                            java.util.Comparator<? super K> comparator)
        Description copied from class: IList
        Searches the specified range for an object using the binary search algorithm.

        Note that the method is defined to work with an arbitrary type <K>. This allows to search directly for a key field in the object without the need to construct an object containing the key: 

        
 persons.binarySearch("john", new SearchByName());
 
 class SearchByName implements Comparator<Object> {
	 public int compare(Object o1, Object o2) {
	   String s1 = (o1 instanceof String) ? (String) o1 : ((Name) o1).getName();
	   String s2 = (o2 instanceof String) ? (String) o2 : ((Name) o2).getName();
	   return s1.compareTo(s2);
	 }
 }
 /
        Specified by:
        binarySearch in class IList<E>
        Parameters:
        index - index of first element to search
        len - number of elements to search
        key - the value to be searched for
        comparator - the comparator by which the list is ordered. A null value indicates that the elements' natural ordering should be used.
        Returns:
        index of the search key, if it is contained in the array; otherwise, (-(insertion point) - 1). The insertion point is defined as the point at which the key would be inserted into the array: the index of the first element greater than the key, or a.length if all elements in the array are less than the specified key. Note that this guarantees that the return value will be >= 0 if and only if the key is found.
        See Also:
        Arrays.binarySearch(long[], long)

      • error

        private void error()
        Throw exception if an attempt is made to change an immutable list.