Package de.intarsys.tools.functor

Class DeclaredArgs

java.lang.Object
de.intarsys.tools.functor.DeclaredArgs
All Implemented Interfaces:
IArgs
public class DeclaredArgs extends Object implements IArgs
This IArgs implementation allows the declaration of arguments.

The declaration is matched against the actual arguments defined in args. The declaration defines a mapping from indexed to named and AND vice versa.

If we have indexed args, a declaration associates a name with the argument in the sequence of declaration.

If we have named args, a declaration defines the index of the argument with the same name.

  • Constructor Details

    • DeclaredArgs

      protected DeclaredArgs(IArgs args)

  • Method Details

    • createStrict

      public static DeclaredArgs createStrict(IArgs args)

    • createStrictIfDeclared

      public static DeclaredArgs createStrictIfDeclared(IArgs args)

    • createTransparent

      public static DeclaredArgs createTransparent(IArgs args)

    • add

      public void add(Object object)
      Specified by:
      add in interface IArgs

    • clear

      public void clear()
      Specified by:
      clear in interface IArgs

    • declare

      protected void declare(IFunctorCall call, ArgumentDeclaration argDecl) throws DeclarationException
      Throws:
      DeclarationException

    • declare

      protected void declare(IFunctorCall call, String name, int index, IFunctor defaultFunctor) throws DeclarationException
      Throws:
      DeclarationException

    • get

      public Object get(int pIndex)
      Description copied from interface: IArgs
      The argument at position index.
      Specified by:
      get in interface IArgs
      Parameters:
      pIndex - The index of the argument to return.
      Returns:
      The argument at position index.

    • get

      public Object get(int pIndex, Object defaultValue)
      Description copied from interface: IArgs
      The argument at position index
      Specified by:
      get in interface IArgs
      Parameters:
      pIndex - The index of the argument to return.
      defaultValue - The default value to be returned if argument is not available.
      Returns:
      The argument at position index

    • get

      public Object get(String name)
      Description copied from interface: IArgs
      The argument named name.
      Specified by:
      get in interface IArgs
      Parameters:
      name - The name of the argument to return.
      Returns:
      The argument named name .

    • get

      public Object get(String name, Object defaultValue)
      Description copied from interface: IArgs
      The argument named name or the defaultValue if not available.
      Specified by:
      get in interface IArgs
      Parameters:
      name - The name of the argument to return.
      defaultValue - The default value to be returned if argument is not available.
      Returns:
      The argument named name

    • getArgsIn

      public IArgs getArgsIn()

    • isDefined

      public boolean isDefined(int index)
      Description copied from interface: IArgs
      true if an argument at index is defined.
      Specified by:
      isDefined in interface IArgs
      Parameters:
      index -
      Returns:
      true if an argument at index is defined.

    • isDefined

      public boolean isDefined(String name)
      Description copied from interface: IArgs
      true if an argument named name is defined.
      Specified by:
      isDefined in interface IArgs
      Parameters:
      name -
      Returns:
      true if an argument named name is defined.

    • isIndexed

      public boolean isIndexed()
      Description copied from interface: IArgs
      true if this argument list is indexed. This means its elements are available via integer indexes.

      This does NOT mean the arguments are not available via names - there are implementations that can support both.

      Specified by:
      isIndexed in interface IArgs
      Returns:
      true if this argument list is indexed.

    • isLazy

      protected boolean isLazy()

    • isNamed

      public boolean isNamed()
      Description copied from interface: IArgs
      true if this argument list is named. This means its elements are available via names.

      This does NOT mean the arguments are not available via indexes - there are implementations that can support both.

      Specified by:
      isNamed in interface IArgs
      Returns:
      true if this argument list is named.

    • isStrict

      protected boolean isStrict()

    • names

      public Set names()
      Description copied from interface: IArgs
      The set of all argument names in the argument list if this argument list is not indexed or null.
      Specified by:
      names in interface IArgs
      Returns:
      The set of all argument names in the argument list if this argument list is not indexed or null.

    • put

      public void put(int index, Object value)
      Specified by:
      put in interface IArgs

    • put

      public void put(String name, Object value)
      Specified by:
      put in interface IArgs

    • setLazy

      protected void setLazy(boolean lazy)

    • setStrict

      protected void setStrict(boolean strict)

    • size

      public int size()
      Description copied from interface: IArgs
      The total number of arguments.
      Specified by:
      size in interface IArgs
      Returns:
      The total number of arguments.

    • switchArgs

      protected void switchArgs()

    • toString

      public String toString()
      Overrides:
      toString in class Object