Constructor Detail

• BaseXmlInspectorConfig

  public BaseXmlInspectorConfig()

Method Detail

• setInputStreams

  public BaseXmlInspectorConfig setInputStreams(InputStream... streams)

  Sets the InputStreams of multiple XML files.

  This method is more advanced than setInputStream, as it combines multiple files, but it is slightly more cumbersome to configure in metawidget.xml.

  Returns:

  this, as part of a fluent interface

• setInputStream

  public BaseXmlInspectorConfig setInputStream(InputStream stream)

  Sets the InputStream of the XML.

  Returns:

  this, as part of a fluent interface

• setResourceResolver

  public void setResourceResolver(ResourceResolver resourceResolver)

  Description copied from interface: NeedsResourceResolver
  Set the ResourceResolver for this class.

  Note: we tried removing this interface, and having ConfigReader look for xxxConfig classes that took a ResourceResolver parameter in their constructor instead. This had disadvantages:

  • you start dictating how a class' constructor must look, which degrades the POJO approach
  • you end up using reflection to determine what constructor parameters there are. In general, an API should favour interfaces over reflection
  • you require clients to think about ResourceResolver when constructing the class programmatically. They can pass null, but this really calls for a default constructor. But if you have a default constructor, all subclasses must implement two constructors, and many must therefore make two calls to setDefaultFile

  Specified by:

  setResourceResolver in interface NeedsResourceResolver

• setDocuments

  public BaseXmlInspectorConfig setDocuments(Document... document)

  Sets the XML using a DOM Document.

  Returns:

  this, as part of a fluent interface

• setRestrictAgainstObject

  public BaseXmlInspectorConfig setRestrictAgainstObject(PropertyStyle restrictAgainstObject)

  Sets the property style used to restrict XML inspection against the given Object. This applies when mixing XML-based Inspectors (e.g. XmlInspector) and Object-based Inspectors (e.g. PropertyTypeInspector) in the same application (i.e. via CompositeInspector).

  You may encounter a problem whereby the Object-based Inspector will always stop at null or recursive references, whereas the XML Inspector (which have no knowledge of Object values) will continue. This can lead to the WidgetBuilders constructing a UI for a null Object, which may upset some WidgetProcessors (e.g. BeansBindingProcessor). To resolve this, you can set BaseXmlInspectorConfig.setRestrictAgainstObject, whereby the XML-based Inspector will do a check for null or recursive references, and not return any XML. In addition, setting restrictAgainstObject allows the XML Inspector to traverse child relationships and infer their types using the Object. This saves having to explicitly specify those relationships in the XML.

  Returns:

  this, as part of a fluent interface

• setInferInheritanceHierarchy

  public BaseXmlInspectorConfig setInferInheritanceHierarchy(boolean inferInheritanceHierarchy)

  Sets whether to infer the inheritance heirarchy of types in the XML by looking them up against corresponding Java Classes. This saves having to explicitly specify the inheritance heirarchy in the XML.

  Note this does not infer child relationships. For that, use setRestrictAgainstObject (which also implies setInferInheritanceHierarchy).

  Returns:

  this, as part of a fluent interface

• setValidateAgainstClasses

  public BaseXmlInspectorConfig setValidateAgainstClasses(PropertyStyle validateAgainstClasses)

  Sets the property style used to validate whether properties defined in the XML match those defined by the corresponding Java Classes.

  Returns:

  this, as part of a fluent interface

• equals

  public boolean equals(Object that)

  Overrides:

  equals in class Object

• hashCode

  public int hashCode()

  Overrides:

  hashCode in class Object

• setDefaultFile

  protected void setDefaultFile(String defaultFile)

• getInputStreams

  protected InputStream[] getInputStreams()

• getResourceResolver

  protected ResourceResolver getResourceResolver()

• getDocuments

  protected Document[] getDocuments()

• getRestrictAgainstObject

  protected PropertyStyle getRestrictAgainstObject()

• isInferInheritanceHierarchy

  protected boolean isInferInheritanceHierarchy()

• getValidateAgainstClasses

  protected PropertyStyle getValidateAgainstClasses()