com.phloc.json.IJSONProperty 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 javax.annotation.Nonnull;

import com.phloc.commons.annotations.Nonempty;
import com.phloc.commons.name.IHasName;

/**
 * Interface describing a JSON object property. Properties can again be JSON
 * objects and therefore be used to build object hierarchies.

 * A {@link IJSONProperty} consists of the following two parts:

 * 
 * name: {@link String}
 * value: {@link IJSONPropertyValue}
 * 
 * 
 * @author Boris Gregorcic
 */
public interface IJSONProperty  extends IJSON, IHasName
{
  /**
   * @return the name of the property (unique in the scope of a
   *         {@link IJSONObject})
   */
  @Override
  @Nonnull
  @Nonempty
  String getName ();

  /**
   * @return the current value ({@link IJSONPropertyValue}), may not be
   *         null
   */
  @Nonnull
  IJSONPropertyValue  getValue ();

  /**
   * Sets the passed value in this property
   * 
   * @param aValue
   *        Value to set, may not be null
   */
  void setValue (@Nonnull IJSONPropertyValue  aValue);

  /**
   * {@inheritDoc}
   */
  @Override
  @Nonnull
  IJSONProperty  getClone ();
}