odata2-lib/odata-core/src/main/java/org/apache/olingo/odata2/core/uri/expression/InfoMethod.java

/*******************************************************************************
 * 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.odata2.core.uri.expression;

import java.util.List;

import org.apache.olingo.odata2.api.edm.EdmType;
import org.apache.olingo.odata2.api.uri.expression.MethodOperator;

/**
 * Describes a method expression which is allowed in OData expressions
 * 
 */
class InfoMethod {

  private MethodOperator method;
  private String syntax;
  private int minParameter;
  private int maxParameter;
  ParameterSetCombination combination;

  public InfoMethod(final MethodOperator method, final ParameterSetCombination combination) {
    this.method = method;
    syntax = method.toUriLiteral();
    minParameter = 1;
    maxParameter = 1;
    this.combination = combination;
  }

  public InfoMethod(final MethodOperator method, final int minParameters, final int maxParameters,
      final ParameterSetCombination combination) {
    this.method = method;
    syntax = method.toUriLiteral();
    minParameter = minParameters;
    maxParameter = maxParameters;
    this.combination = combination;
  }

  public InfoMethod(final MethodOperator method, final String string, final int minParameters, final int maxParameters,
      final ParameterSetCombination combination) {
    this.method = method;
    syntax = string;
    minParameter = minParameters;
    maxParameter = maxParameters;
    this.combination = combination;
  }

  public MethodOperator getMethod() {
    return method;
  }

  public String getSyntax() {
    return syntax;
  }

  public int getMinParameter() {
    return minParameter;
  }

  public int getMaxParameter() {
    return maxParameter;
  }

  public ParameterSet validateParameterSet(final List<EdmType> actualParameterTypes)
      throws ExpressionParserInternalError {
    return combination.validate(actualParameterTypes);
  }

  /**
   * Returns the EdmType of the returned value of a Method
   * If a method may have different return types (depending on the input type) null will be returned.
   */
  public EdmType getReturnType() {
    return combination.getReturnType();

  }
}