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 LinkedHashSet} with a convenience {@link #append(Object)} method.
019 *
020 * <p>
021 * Primarily used for testing purposes for quickly creating populated sets.
022 * <p class='bcode w800'>
023 *    <jc>// Example:</jc>
024 *    Set&lt;String&gt; s = <jk>new</jk> ASet&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 ASet<T> extends LinkedHashSet<T> {
031
032   // TODO - Change to 1L in 8.0
033   private static final long serialVersionUID = -7789361749029840633L;
034
035   /**
036    * Convenience method for creating a list of objects.
037    *
038    * @param t The initial values.
039    * @return A new list.
040    */
041   public static <T> ASet<T> create(T...t) {
042      return new ASet<T>().appendAll(t);
043   }
044
045   /**
046    * Adds an entry to this set.
047    *
048    * @param t The entry to add to this set.
049    * @return This object (for method chaining).
050    */
051   public ASet<T> append(T t) {
052      add(t);
053      return this;
054   }
055
056   /**
057    * Adds multiple entries to this set.
058    *
059    * @param t The entries to add to this set.
060    * @return This object (for method chaining).
061    */
062   public ASet<T> appendAll(T...t) {
063      addAll(Arrays.asList(t));
064      return this;
065   }
066
067   /**
068    * Adds a value to this set if the boolean value is <jk>true</jk>
069    *
070    * @param b The boolean value.
071    * @param t The value to add.
072    * @return This object (for method chaining).
073    */
074   public ASet<T> appendIf(boolean b, T t) {
075      if (b)
076         append(t);
077      return this;
078   }
079}