Constructor Detail

• EffectorUtils

  public EffectorUtils()

Method Detail

• prepareArgsForEffector

  public static java.lang.Object[] prepareArgsForEffector(Effector<?> eff,
                                          java.lang.Object args)

  prepares arguments for an effector either accepting: an array, which should contain the arguments in order, optionally omitting those which have defaults defined; or a map, which should contain the arguments by name, again optionally omitting those which have defaults defined, and in this case also performing type coercion.

• prepareArgsForEffectorAsMapFromArray

  public static java.util.Map prepareArgsForEffectorAsMapFromArray(Effector<?> eff,
                                                   java.lang.Object[] args)

• oldPrepareArgsForEffector

  public static java.lang.Object[] oldPrepareArgsForEffector(Effector<?> eff,
                                             java.lang.Object args)

  Takes arguments, and returns an array of arguments suitable for use by the Effector according to the ParameterTypes it exposes.

  The args can be:

  1. an array of ordered arguments
  2. a collection (which will be automatically converted to an array)
  3. a single argument (which will then be wrapped in an array)
  4. a map containing the (named) arguments
  5. an array or collection single entry of a map (treated same as 5 above)
  6. a semi-populated array or collection that also containing a map as first arg - uses ordered args in array, but uses named values from map in preference.
  7. semi-populated array or collection, where default values will otherwise be used.

• invokeMethodEffector

  public static <T> T invokeMethodEffector(Entity entity,
                           Effector<T> eff,
                           java.lang.Object[] args)

  Invokes a method effector so that its progress is tracked. For internal use only, when we know the effector is backed by a method which is local.

• handleEffectorException

  public static void handleEffectorException(Entity entity,
                             Effector<?> effector,
                             java.lang.Throwable throwable)

• invokeEffectorAsync

  public static <T> Task<T> invokeEffectorAsync(Entity entity,
                                Effector<T> eff,
                                java.util.Map<java.lang.String,?> parameters)

• findEffectorMatching

  @Deprecated
  public static Effector<?> findEffectorMatching(Entity entity,
                                            java.lang.reflect.Method method)

  Deprecated. since 0.7.0, not used

• findEffectorMatching

  @Deprecated
  public static Effector<?> findEffectorMatching(java.util.Set<Effector<?>> effectors,
                                            java.lang.String effectorName,
                                            java.util.Map<java.lang.String,?> parameters)

  Deprecated. since 0.7.0, expects parameters but does not use them!

• findEffector

  public static Maybe<Effector<?>> findEffector(java.util.Collection<? extends Effector<?>> effectors,
                                java.lang.String effectorName)

  matches effectors by name only (not parameters)

• findEffectorDeclared

  public static Maybe<Effector<?>> findEffectorDeclared(Entity entity,
                                        java.lang.String effectorName)

  matches effectors by name only (not parameters), based on what is declared on the entity static type

• getTaskFlagsForEffectorInvocation

  public static java.util.Map<java.lang.Object,java.lang.Object> getTaskFlagsForEffectorInvocation(Entity entity,
                                                                                   Effector<?> effector)

  Deprecated. since 0.7.0 use getTaskFlagsForEffectorInvocation(Entity, Effector, ConfigBag)

• getTaskFlagsForEffectorInvocation

  public static java.util.Map<java.lang.Object,java.lang.Object> getTaskFlagsForEffectorInvocation(Entity entity,
                                                                                   Effector<?> effector,
                                                                                   ConfigBag parameters)

  returns a (mutable) map of the standard flags which should be placed on an effector