commons-jcs-core/src/main/java/org/apache/commons/jcs/utils/struct/DoubleLinkedListNode.java

package org.apache.commons.jcs.utils.struct;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import java.io.Serializable;

/**
 * This serves as a placeholder in a double linked list. You can extend this to
 * add functionality. This allows you to remove in constant time from a linked
 * list.
 * <p>
 * It simply holds the payload and a reference to the items before and after it
 * in the list.
 */
public class DoubleLinkedListNode<T>
    implements Serializable
{
    /** Dont' change. */
    private static final long serialVersionUID = -1114934407695836097L;

    /** The object in the node. */
    private final T payload;

    /** Double Linked list references */
    public DoubleLinkedListNode<T> prev;

    /** Double Linked list references */
    public DoubleLinkedListNode<T> next;

    /**
     * @param payloadP
     */
    public DoubleLinkedListNode(T payloadP)
    {
        payload = payloadP;
    }

    /**
     * @return Object
     */
    public T getPayload()
    {
        return payload;
    }
}