InspectableFactory

com.froglogic.squish.extension.InspectableFactory

Interface InspectableFactory — A Factory that delivers an Inspectable for custom Objects that it manages.

Synopsis

public interface com.froglogic.squish.extension.InspectableFactory {

// Public Static Fields
  public static final int MAX_PRIORITY = 10;
  public static final int MIN_PRIORITY = 1;
  public static final int NORM_PRIORITY = 5;

// Public Methods
  public abstract int priority();
  public abstract com.froglogic.squish.extension.Inspectable query(java.lang.Object object);
}

Description

A Factory that delivers an Inspectable for custom Objects that it manages.

Fields

MAX_PRIORITY

public static final int MAX_PRIORITY = 10;

The maximum priority that an InspectableFactory can have.

MIN_PRIORITY

public static final int MIN_PRIORITY = 1;

The minimum priority that an InspectableFactory can have.

NORM_PRIORITY

public static final int NORM_PRIORITY = 5;

A good default priority for an InspectableFactory.

Methods

priority()

public abstract int priority();

Parameters
return	a value indicating the priority of this factory.

The priority of this factory. Possible values should lie between MIN_PRIORITY (1) and MAX_PRIORITY(10). The priority NORM_PRIORITY is a good default value to use.

query(Object)

public abstract com.froglogic.squish.extension.Inspectable query(java.lang.Object object);

Parameters
object	the Object to get an Inspectable for.
return	an Inspectable that handles the queried object, otherwise null.

Query this factory for an Inspectable that can handle Object object.