jhelp.util.list

Class ListFromArray<TYPE>

java.lang.Object

jhelp.util.list.ListFromArray<TYPE>

Type Parameters:

TYPE - Type of the element in the array

All Implemented Interfaces:

java.lang.Iterable<TYPE>, java.util.Collection<TYPE>, java.util.List<TYPE>

public class ListFromArray<TYPE>
extends java.lang.Object
implements java.util.List<TYPE>

List based on a fix array.
If an element change from this list, it is also modified to the linked array.
This ist have some restriction, you can't add or remove element from it. But its possible to read/modfy and element

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
private TYPE[]	array Linked array
private int	length Array length
private boolean	modifiable Indicates if modify an element is allowed

Constructor Summary

Constructors

Constructor and Description
ListFromArray(boolean modifiable, TYPE... array) Create a new instance of ListFromArray
ListFromArray(TYPE... array) Create a new instance of ListFromArray

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int index, TYPE element) Not permitted operation.
boolean	add(TYPE e) Not permitted operation.
boolean	addAll(java.util.Collection<? extends TYPE> c) Not permitted operation.
boolean	addAll(int index, java.util.Collection<? extends TYPE> c) Not permitted operation.
private void	checkIndex(int index) Check if an index is inside the array
void	clear() Not permitted operation.
boolean	contains(java.lang.Object o) Indicates if an element is inside the list Parent documentation:
boolean	containsAll(java.util.Collection<?> c) Indicates if all elements of a collection is inside the list Parent documentation:
TYPE	get(int index) Obtain an element from the list Parent documentation:
int	indexOf(java.lang.Object o) Compute index of an element Parent documentation:
boolean	isEmpty() Indicates if list is empty Parent documentation:
boolean	isModifiable() Indicates if it is allowed to modify elements inside the list throw set(int, Object) method
java.util.Iterator<TYPE>	iterator() Create iterator over the list Parent documentation:
int	lastIndexOf(java.lang.Object o) Compute index, form the end, that corresponds to a specific object Parent documentation:
java.util.ListIterator<TYPE>	listIterator() Create list iterator over the list Parent documentation:
java.util.ListIterator<TYPE>	listIterator(int index) Create list iterator that start to a given index Parent documentation:
TYPE	remove(int index) Not permitted operation.
boolean	remove(java.lang.Object o) Not permitted operation.
boolean	removeAll(java.util.Collection<?> c) Not permitted operation.
boolean	retainAll(java.util.Collection<?> c) Not permitted operation.
TYPE	set(int index, TYPE element) Modify a element of the list.
int	size() List size Parent documentation:
java.util.List<TYPE>	subList(int fromIndex, int toIndex) Extract a sub list from the list Parent documentation:
java.lang.Object[]	toArray() Convert list to array Parent documentation:
<T> T[]	toArray(T[] a) Convert list to array Parent documentation:

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.List

equals, hashCode

Field Detail

array

private final TYPE[] array

Linked array

length

private final int length

Array length

modifiable

private final boolean modifiable

Indicates if modify an element is allowed

Constructor Detail

ListFromArray

public ListFromArray(boolean modifiable,
             TYPE... array)

Create a new instance of ListFromArray

Parameters:

modifiable - Indicates if modify an element is allowed

array - Array to link to the list

ListFromArray

public ListFromArray(TYPE... array)

Create a new instance of ListFromArray

Parameters:

array - Array to link to the list

Method Detail

checkIndex

private void checkIndex(int index)

Check if an index is inside the array

Parameters:

index - Index to check

add

public void add(int index,
       TYPE element)

Not permitted operation. Always throw UnsupportedOperationException

Parent documentation:

Specified by:

add in interface java.util.List<TYPE>

Parameters:

index - Ignored

element - Ignored

See Also:

List.add(int, java.lang.Object)

add

public boolean add(TYPE e)

Not permitted operation. Always throw UnsupportedOperationException

Parent documentation:

Specified by:

add in interface java.util.Collection<TYPE>

Specified by:

add in interface java.util.List<TYPE>

Parameters:

e - Ignored

Returns:

Never return

See Also:

List.add(java.lang.Object)

addAll

public boolean addAll(java.util.Collection<? extends TYPE> c)

Not permitted operation. Always throw UnsupportedOperationException

Parent documentation:

Specified by:

addAll in interface java.util.Collection<TYPE>

Specified by:

addAll in interface java.util.List<TYPE>

Parameters:

c - Ignored

Returns:

Never return

See Also:

List.addAll(java.util.Collection)

addAll

public boolean addAll(int index,
             java.util.Collection<? extends TYPE> c)

Not permitted operation. Always throw UnsupportedOperationException

Parent documentation:

Specified by:

addAll in interface java.util.List<TYPE>

Parameters:

index - Ignored

c - Ignored

Returns:

Never return

See Also:

List.addAll(int, java.util.Collection)

clear

public void clear()

Not permitted operation. Always throw UnsupportedOperationException

Parent documentation:

Specified by:

clear in interface java.util.Collection<TYPE>

Specified by:

clear in interface java.util.List<TYPE>

See Also:

List.clear()

contains

public boolean contains(java.lang.Object o)

Indicates if an element is inside the list

Parent documentation:

Specified by:

contains in interface java.util.Collection<TYPE>

Specified by:

contains in interface java.util.List<TYPE>

Parameters:

o - Object test

Returns:

true if element is inside

See Also:

List.contains(java.lang.Object)

containsAll

public boolean containsAll(java.util.Collection<?> c)

Indicates if all elements of a collection is inside the list

Parent documentation:

Specified by:

containsAll in interface java.util.Collection<TYPE>

Specified by:

containsAll in interface java.util.List<TYPE>

Parameters:

c - Collection of element to test

Returns:

true if all elements are inside

See Also:

List.containsAll(java.util.Collection)

get

public TYPE get(int index)

Obtain an element from the list

Parent documentation:

Specified by:

get in interface java.util.List<TYPE>

Parameters:

index - Element index

Returns:

Element get

See Also:

List.get(int)

indexOf

public int indexOf(java.lang.Object o)

Compute index of an element

Parent documentation:

Specified by:

indexOf in interface java.util.List<TYPE>

Parameters:

o - Element search

Returns:

Element index

See Also:

List.indexOf(java.lang.Object)

isEmpty

public boolean isEmpty()

Indicates if list is empty

Parent documentation:

Specified by:

isEmpty in interface java.util.Collection<TYPE>

Specified by:

isEmpty in interface java.util.List<TYPE>

Returns:

true if list is empty

See Also:

List.isEmpty()

isModifiable

public boolean isModifiable()

Indicates if it is allowed to modify elements inside the list throw set(int, Object) method

Returns:

true if modification are allowed

iterator

public java.util.Iterator<TYPE> iterator()

Create iterator over the list

Parent documentation:

Specified by:

iterator in interface java.lang.Iterable<TYPE>

Specified by:

iterator in interface java.util.Collection<TYPE>

Specified by:

iterator in interface java.util.List<TYPE>

Returns:

Iterator

See Also:

List.iterator()

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Compute index, form the end, that corresponds to a specific object

Parent documentation:

Specified by:

lastIndexOf in interface java.util.List<TYPE>

Parameters:

o - Object search

Returns:

Last index of the object

See Also:

List.lastIndexOf(java.lang.Object)

listIterator

public java.util.ListIterator<TYPE> listIterator()

Create list iterator over the list

Parent documentation:

Specified by:

listIterator in interface java.util.List<TYPE>

Returns:

List iterator

See Also:

List.listIterator()

listIterator

public java.util.ListIterator<TYPE> listIterator(int index)

Create list iterator that start to a given index

Parent documentation:

Specified by:

listIterator in interface java.util.List<TYPE>

Parameters:

index - Index to start

Returns:

List iterator

See Also:

List.listIterator(int)

remove

public TYPE remove(int index)

Not permitted operation. Always throw UnsupportedOperationException

Parent documentation:

Specified by:

remove in interface java.util.List<TYPE>

Parameters:

index - Ignored

Returns:

Never return

See Also:

List.remove(int)

remove

public boolean remove(java.lang.Object o)

Not permitted operation. Always throw UnsupportedOperationException

Parent documentation:

Specified by:

remove in interface java.util.Collection<TYPE>

Specified by:

remove in interface java.util.List<TYPE>

Parameters:

o - Ignored

Returns:

Never return

See Also:

List.remove(java.lang.Object)

removeAll

public boolean removeAll(java.util.Collection<?> c)

Not permitted operation. Always throw UnsupportedOperationException

Parent documentation:

Specified by:

removeAll in interface java.util.Collection<TYPE>

Specified by:

removeAll in interface java.util.List<TYPE>

Parameters:

c - Ignored

Returns:

Never return

See Also:

List.removeAll(java.util.Collection)

retainAll

public boolean retainAll(java.util.Collection<?> c)

Not permitted operation. Always throw UnsupportedOperationException

Parent documentation:

Specified by:

retainAll in interface java.util.Collection<TYPE>

Specified by:

retainAll in interface java.util.List<TYPE>

Parameters:

c - Ignored

Returns:

Never return

See Also:

List.retainAll(java.util.Collection)

set

public TYPE set(int index,
       TYPE element)

Modify a element of the list.
It throws a UnsupportedOperationException if the list is not modifiable

Parent documentation:

Specified by:

set in interface java.util.List<TYPE>

Parameters:

index - Index of element to change

element - New value

Returns:

Previous value

See Also:

List.set(int, java.lang.Object)

size

public int size()

List size

Parent documentation:

Specified by:

size in interface java.util.Collection<TYPE>

Specified by:

size in interface java.util.List<TYPE>

Returns:

List size

See Also:

List.size()

subList

public java.util.List<TYPE> subList(int fromIndex,
                           int toIndex)

Extract a sub list from the list

Parent documentation:

Specified by:

subList in interface java.util.List<TYPE>

Parameters:

fromIndex - Start index

toIndex - End index

Returns:

Sub list

See Also:

List.subList(int, int)

toArray

public java.lang.Object[] toArray()

Convert list to array

Parent documentation:

Specified by:

toArray in interface java.util.Collection<TYPE>

Specified by:

toArray in interface java.util.List<TYPE>

Returns:

Array result (copy of linked array)

See Also:

List.toArray()

toArray

public <T> T[] toArray(T[] a)

Convert list to array

Parent documentation:

Specified by:

toArray in interface java.util.Collection<TYPE>

Specified by:

toArray in interface java.util.List<TYPE>

Type Parameters:

T - Element type

Parameters:

a - Array to receive result

Returns:

Array copy

See Also:

java.util.List#toArray(T[])