001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.utils;
014
015import java.util.*;
016
017/**
018 * An extension of {@link LinkedList} with a convenience {@link #append(Object)} method.
019 *
020 * <p>
021 * Primarily used for testing purposes for quickly creating populated lists.
022 * <p class='bcode w800'>
023 *    <jc>// Example:</jc>
024 *    List&lt;String&gt; l = <jk>new</jk> AList&lt;String&gt;().append(<js>"foo"</js>).append(<js>"bar"</js>);
025 * </p>
026 *
027 * @param <T> The entry type.
028 */
029@SuppressWarnings({"unchecked"})
030public final class AList<T> extends LinkedList<T> {
031
032   private static final long serialVersionUID = 1L;
033
034   /**
035    * Convenience method for creating a list of objects.
036    *
037    * @param t The initial values.
038    * @return A new list.
039    */
040   @SafeVarargs
041   public static <T> AList<T> create(T...t) {
042      return new AList<T>().appendAll(t);
043   }
044
045   /**
046    * Convenience method for creating a list of objects.
047    *
048    * <p>
049    * Identical to {@link #create(Object...)}.
050    *
051    * @param t The initial values.
052    * @return A new list.
053    */
054   @SafeVarargs
055   public static <T> AList<T> of(T...t) {
056      return new AList<T>().appendAll(t);
057   }
058
059   /**
060    * Adds an entry to this list.
061    *
062    * @param t The entry to add to this list.
063    * @return This object (for method chaining).
064    */
065   public AList<T> append(T t) {
066      add(t);
067      return this;
068   }
069
070   /**
071    * Adds multiple entries to this list.
072    *
073    * @param t The entries to add to this list.
074    * @return This object (for method chaining).
075    */
076   public AList<T> appendAll(T...t) {
077      addAll(Arrays.asList(t));
078      return this;
079   }
080
081   /**
082    * Adds an entry to this list if the boolean flag is <jk>true</jk>.
083    *
084    * @param b The boolean flag.
085    * @param val The value to add.
086    * @return This object (for method chaining).
087    */
088   public AList<T> appendIf(boolean b, T val) {
089      if (b)
090         append(val);
091      return this;
092   }
093}