Package repast.simphony.parameter

Interface Schema

All Known Implementing Classes:
DefaultSchema
public interface Schema
Maps parameter names to a type.
Version:
$Revision$ $Date$
Author:
Nick Collier

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    contains(String paramName)
    Returns true if this schema contains contains the specified parameter name, otherwise false.
    ParameterSchema
    getDetails(String paramName)
    Gets the schema for the specified parameter.
    Iterable<String>
    parameterNames()
    Gets an iterable over a list of parameter names.
    int
    size()
    Gets the number of parameters in this schema.
    boolean
    validate(String paramName, Object obj)
    Validates the specified object against the type info contained for the parameter name.

  • Method Details

    • getDetails

      ParameterSchema getDetails(String paramName)
      Gets the schema for the specified parameter.
      Parameters:
      paramName - the name of the parameter
      Returns:
      the schema for the specified parameter

    • parameterNames

      Iterable<String> parameterNames()
      Gets an iterable over a list of parameter names.
      Returns:
      an iterable over a list of parameter names.

    • validate

      boolean validate(String paramName, Object obj)
      Validates the specified object against the type info contained for the parameter name.
      Parameters:
      paramName - the name of the parameter
      obj - the object to validate
      Returns:
      true if the object is of a type valid for the parameter, otherwise false.

    • contains

      boolean contains(String paramName)
      Returns true if this schema contains contains the specified parameter name, otherwise false.
      Parameters:
      paramName -
      Returns:
      true if this schema contains contains the specified parameter name, otherwise false.

    • size

      int size()
      Gets the number of parameters in this schema.
      Returns:
      the number of parameters in this schema.