• Status: Solved
  • Priority: Medium
  • Security: Public
  • Views: 294
  • Last Modified:

Why are there two add methods in LinkedList?

In lines 39 through 49 of the Java code below, I can understand why there is an add method with a void return type, but why is there another add method with a boolean return type? The first add method seems to be accessing the second add method, which simply adds a node before a specified index, right? Why doesn't this class just have one add method to keep things simple?
public class MyLinkedList<AnyType> implements Iterable<AnyType> {

	private int theSize;
	private int modCount = 0;
	private Node<AnyType> beginMarker;
	private Node<AnyType> endMarker;

	private static class Node<AnyType> 
		public Node( AnyType d, Node<AnyType> p, Node<AnyType> n ) {
			data = d; prev = p; next = n;}

		public AnyType data; 
		public Node<AnyType>  prev;
		public Node<AnyType>  next;

	public MyLinkedList( ) {
		clear( );}

	public void clear( ) // Change the size of this collection to zero.
		beginMarker = new Node<AnyType>( null, null, null ); 
		endMarker = new Node<AnyType>( null, beginMarker, null ); 
		beginMarker.next = endMarker;

		theSize = 0;

	public int size( ) { //Returns the number of items in this collection.
		return theSize; 

	public boolean isEmpty( ) { 
		return size( ) == 0;} // test to see if this is true

	public boolean add( AnyType x ) { //Adds an item to this collection, at the end
		add( size( ), x );
		return true;

	/* the add method adds an item to this collection, at specified position. 
         Items at or after that 	position are slid one position higher */

	public void add( int idx, AnyType x ) {
		addBefore( getNode( idx), x );}

	public AnyType get( int idx ) { // Returns the item at position idx
		return getNode( idx ).data;}

	public AnyType set( int idx, AnyType newVal ) { //Changes the item at position idx
		Node<AnyType> p = getNode( idx );
		AnyType oldVal = p.data;
		p.data = newVal; 
		return oldVal;

	public AnyType remove( int idx ) { //Removes an item from this collection
		return	remove(getNode( idx ));}

	/* this addBefore method adds an item to this collection, at specified position p. 
	Items at or after that position are slid one position higher */

	private void addBefore( Node<AnyType> p, AnyType x ) {
		Node<AnyType> newNode = new Node<AnyType>( x, p.prev, p ); 
		newNode.prev.next = newNode; 
		p.prev = newNode; 

	private AnyType remove( Node<AnyType> p ) {  // Removes the object contained in Node p.
		p.next.prev = p.prev; 
		p.prev.next = p.next; 
		return p.data;

	private Node<AnyType> getNode( int idx)
		Node<AnyType> p;
		if( idx < 0 || idx > size() )
            throw new IndexOutOfBoundsException();
        if( idx < size( ) / 2 ) {
            p = beginMarker.next;
            for( int i = 0; i < idx; i++ )
                p = p.next;            
            p = endMarker;
            for( int i = size( ); i > idx; i-- )
                p = p.prev;
		return p;

	public java.util.Iterator<AnyType> iterator( ) {
        return new LinkedListIterator( );

	private class LinkedListIterator implements java.util.Iterator<AnyType>
		private Node<AnyType> current = beginMarker.next;
       private int expectedModCount = modCount; 
		private boolean okToRemove = false;
		public boolean hasNext( ) {
			return current != endMarker;
        public AnyType next( )
            if( modCount != expectedModCount )
                throw new java.util.ConcurrentModificationException( ); 
            if( !hasNext( ) )
                throw new java.util.NoSuchElementException( ); 
            AnyType nextItem = current.data;
            current = current.next;
            okToRemove = true;
            return nextItem;
        public void remove( )
            if( modCount != expectedModCount )
                throw new java.util.ConcurrentModificationException( ); 
            if( !okToRemove )
                throw new IllegalStateException( );
            MyLinkedList.this.remove( current.prev );
            okToRemove = false;  

Open in new window

3 Solutions
one adds at a specified positionthe other adds at the end
In the case of the one that adds to the end, no return code is needed... the list always has an end.  But if you request to add at a specific position, the position might not exist, therefore the function needs to be able to report back the failure.
The reason to have both add functions is to increase the usefulness of the code for the person using the code later.
If you wanted to add something to the end of the list you could just use the second one, but it's easier to just say add(x) and it by default adds it to the end. Most of the time when you are using a list, this is where you add things anyway.

You'll also notice that the second add function calls the addBefore function which is private. The users of the code could all just use that function but the code writer has made it private and given the users the other functions since they are easier to use and safer.

Modern healthcare requires a modern cloud. View this brief video to understand how the Concerto Cloud for Healthcare can help your organization.

to add to above.

the main difference is not the boolean return type (which doesn't actually make much sense as it is always true) but the additional position argument.  

normally, the second function would be called 'insert' or 'insert_before' and not 'add'. if you look at the implementation of the second add function you see they called private 'addBefore' which has a Node<anyType> as first argument. so the three add functions have different level of complexity and only the first two are for public use.

sorry TommySzalapski, i repeated some of your remarks cause i tooks me some time to submit.

shampouyaAuthor Commented:
thanks everybody

Featured Post

Free Tool: IP Lookup

Get more info about an IP address or domain name, such as organization, abuse contacts and geolocation.

One of a set of tools we are providing to everyone as a way of saying thank you for being a part of the community.

Tackle projects and never again get stuck behind a technical roadblock.
Join Now