com.phloc.json.IJSONPropertyValueList Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of phloc-json Show documentation

Library for read and writing JSON objects in a typesafe manner

There is a newer version: 4.2.2

/**
 * Copyright (C) 2006-2015 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]com
 *
 * Licensed 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.
 */
package com.phloc.json;

import java.util.Collection;
import java.util.List;

import javax.annotation.Nonnull;

/**
 * Interface representing a list of property values ({@link IJSONPropertyValue})
 * 
 * @author Boris Gregorcic
 * @param 
 *        The concrete {@link IJSONPropertyValue} type to use
 */
public interface IJSONPropertyValueList > extends
                                                                                  IJSONPropertyValueComplex >
{
  /**
   * @return the list of {@link IJSONPropertyValue}s
   */
  @Nonnull
  List  getValues ();

  /**
   * @return A list of the inner data values (the data items stored inside the
   *         {@link IJSONPropertyValue}s)
   */
  @Nonnull
  List  getDataValues ();

  /**
   * adds the passed value in the list
   * 
   * @param aValue
   *        the value to add
   * @return this
   */
  @Nonnull
  IJSONPropertyValueList  addValue (@Nonnull DATATYPE aValue);

  /**
   * adds all passed values in the list
   * 
   * @param aValues
   *        the values to add
   * @return this
   */
  @Nonnull
  IJSONPropertyValueList  addAllValues (@Nonnull Collection  aValues);

  /**
   * {@inheritDoc}
   */
  @Nonnull
  IJSONPropertyValueList  getClone ();
}