org.apache.olingo.client.api.domain.ClientValue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of odata-v4-lib Show documentation

Repackaged OData V4 Olingo Library

There is a newer version: 3.4.0

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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 org.apache.olingo.client.api.domain;


/**
 * Abstract representation of an OData entity property value.
 */
public interface ClientValue {

  /**
   * Gets value type name.
   * 
   * @return value type name.
   */
  String getTypeName();

  /**
   * Check is is a primitive value.
   * 
   * @return 'TRUE' if primitive; 'FALSE' otherwise.
   */
  boolean isPrimitive();

  /**
   * Casts to primitive value.
   * 
   * @return primitive value.
   */
  ClientPrimitiveValue asPrimitive();

  /**
   * Check is is a collection value.
   * 
   * @return 'TRUE' if collection; 'FALSE' otherwise.
   */
  boolean isCollection();

  /**
   * Casts to collection value.
   * 
   * @param  The actual ODataValue interface.
   * @return collection value.
   */
   ClientCollectionValue asCollection();

  /**
   * Casts to complex value.
   * 
   * @return complex value.
   */
  ClientComplexValue asComplex();

  /**
   * Check is is a linked complex value.
   * 
   * @return 'TRUE' if linked complex; 'FALSE' otherwise.
   */
  boolean isComplex();

  /**
   * Check is is an enum value.
   * 
   * @return 'TRUE' if enum; 'FALSE' otherwise.
   */
  boolean isEnum();

  /**
   * Casts to enum value.
   * 
   * @return enum value.
   */
  ClientEnumValue asEnum();
  
}