Package de.intarsys.tools.functor

Interface IArgs

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ARG_ARGS
      Generic option for the transport of IArgs.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void add​(java.lang.Object object)  
      void clear()  
      java.lang.Object get​(int index)
      The argument at position index.
      java.lang.Object get​(int index, java.lang.Object defaultValue)
      The argument at position index
      java.lang.Object get​(java.lang.String name)
      The argument named name.
      java.lang.Object get​(java.lang.String name, java.lang.Object defaultValue)
      The argument named name or the defaultValue if not available.
      boolean isDefined​(int index)
      true if an argument at index is defined.
      boolean isDefined​(java.lang.String name)
      true if an argument named name is defined.
      boolean isIndexed()
      true if this argument list is indexed.
      boolean isNamed()
      true if this argument list is named.
      java.util.Set<java.lang.String> names()
      The set of all argument names in the argument list if this argument list is not indexed or null.
      void put​(int index, java.lang.Object value)  
      void put​(java.lang.String name, java.lang.Object value)  
      int size()
      The total number of arguments.

    • Field Detail

      • ARG_ARGS

        static final java.lang.String ARG_ARGS
        Generic option for the transport of IArgs.
        See Also:
        Constant Field Values

    • Method Detail

      • add

        void add​(java.lang.Object object)

      • clear

        void clear()

      • get

        java.lang.Object get​(int index)
        The argument at position index.
        Parameters:
        index - The index of the argument to return.
        Returns:
        The argument at position index.

      • get

        java.lang.Object get​(int index,
                     java.lang.Object defaultValue)
        The argument at position index
        Parameters:
        index - 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

        java.lang.Object get​(java.lang.String name)
        The argument named name.
        Parameters:
        name - The name of the argument to return.
        Returns:
        The argument named name .

      • get

        java.lang.Object get​(java.lang.String name,
                     java.lang.Object defaultValue)
        The argument named name or the defaultValue if not available.
        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

      • isDefined

        boolean isDefined​(int index)
        true if an argument at index is defined.
        Parameters:
        index -
        Returns:
        true if an argument at index is defined.

      • isDefined

        boolean isDefined​(java.lang.String name)
        true if an argument named name is defined.
        Parameters:
        name -
        Returns:
        true if an argument named name is defined.

      • isIndexed

        boolean isIndexed()
        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.

        Returns:
        true if this argument list is indexed.

      • isNamed

        boolean isNamed()
        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.

        Returns:
        true if this argument list is named.

      • names

        java.util.Set<java.lang.String> names()
        The set of all argument names in the argument list if this argument list is not indexed or null.
        Returns:
        The set of all argument names in the argument list if this argument list is not indexed or null.

      • put

        void put​(int index,
         java.lang.Object value)

      • put

        void put​(java.lang.String name,
         java.lang.Object value)

      • size

        int size()
        The total number of arguments.
        Returns:
        The total number of arguments.