001package org.apache.commons.jcs.utils.struct;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.io.Serializable;
023
024/**
025 * This serves as a placeholder in a double linked list. You can extend this to
026 * add functionality. This allows you to remove in constant time from a linked
027 * list.
028 * <p>
029 * It simply holds the payload and a reference to the items before and after it
030 * in the list.
031 */
032public class DoubleLinkedListNode<T>
033    implements Serializable
034{
035    /** Dont' change. */
036    private static final long serialVersionUID = -1114934407695836097L;
037
038    /** The object in the node. */
039    private final T payload;
040
041    /** Double Linked list references */
042    public DoubleLinkedListNode<T> prev;
043
044    /** Double Linked list references */
045    public DoubleLinkedListNode<T> next;
046
047    /**
048     * @param payloadP
049     */
050    public DoubleLinkedListNode(T payloadP)
051    {
052        payload = payloadP;
053    }
054
055    /**
056     * @return Object
057     */
058    public T getPayload()
059    {
060        return payload;
061    }
062}