001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.bean.hal;
018
019import java.util.*;
020
021/**
022 * Represents a list of {@link HalLink} objects.
023 *
024 * <p>
025 * Serializes as a top-level JSON array when used as a value inside a HAL {@code _links} map. Mirrors the
026 * top-level-array pattern used by {@code JsonSchemaArray}.
027 *
028 * @serial exclude
029 */
030public class HalLinkArray extends LinkedList<HalLink> {
031
032   private static final long serialVersionUID = 1L;
033
034   /**
035    * Default constructor.
036    */
037   public HalLinkArray() {}
038
039   /**
040    * Constructor with predefined links to add to this array.
041    *
042    * @param value The list of links in this array.
043    */
044   public HalLinkArray(HalLink...value) {
045      addAll(value);
046   }
047
048   /**
049    * Convenience method for adding one or more {@link HalLink} objects to this array.
050    *
051    * @param value The {@link HalLink} objects to add to this array.
052    * @return This object.
053    */
054   public HalLinkArray addAll(HalLink...value) {
055      Collections.addAll(this, value);
056      return this;
057   }
058}