org.metawidget.inspector.impl.BaseObjectInspectorConfig Maven / Gradle / Ivy
// Metawidget
//
// This file is dual licensed under both the LGPL
// (http://www.gnu.org/licenses/lgpl-2.1.html) and the EPL
// (http://www.eclipse.org/org/documents/epl-v10.php). As a
// recipient of Metawidget, you may choose to receive it under either
// the LGPL or the EPL.
//
// Commercial licenses are also available. See http://metawidget.org
// for details.
package org.metawidget.inspector.impl;
import org.metawidget.inspector.impl.actionstyle.ActionStyle;
import org.metawidget.inspector.impl.propertystyle.PropertyStyle;
import org.metawidget.inspector.impl.propertystyle.javabean.JavaBeanPropertyStyle;
import org.metawidget.util.simple.ObjectUtils;
/**
* Base class for BaseObjectInspector configurations.
*
* Handles configuring the convention to use to recognize actions/properties.
*
* Note that whilst BaseObjectInspector is an abstract class,
* BaseObjectInspectorConfig is concrete and instantiable. This is so that subclasses
* of BaseObjectInspector that don't require additional configuration (eg. most of
* them) don't need to further define a Config class, whilst still allowing their
* property/action styles to be configured in the (rare) cases they need to. Incidentally, this is
* why we call this class BaseObjectInspectorConfig as opposed to
* AbstractPropertyInspectorConfig, because a non-abstract class called
* AbstractXXX was deemed confusing! All our other base classes are called
* BaseXXX for consistency. Also see Stephen
* Colebourne's blog.
*
* @author Richard Kennard
*/
public class BaseObjectInspectorConfig {
//
// Private statics
//
private static PropertyStyle DEFAULT_PROPERTY_STYLE;
private static ActionStyle DEFAULT_ACTION_STYLE;
//
// Protected members
//
protected PropertyStyle mPropertyStyle;
protected boolean mNullPropertyStyle;
protected ActionStyle mActionStyle;
protected boolean mNullActionStyle;
//
// Public methods
//
/**
* Sets the style used to recognize properties.
*
* @return this, as part of a fluent interface
*/
public BaseObjectInspectorConfig setPropertyStyle( PropertyStyle propertyStyle ) {
mPropertyStyle = propertyStyle;
mNullPropertyStyle = ( propertyStyle == null );
// Fluent interface
return this;
}
/**
* Sets the style used to recognize actions.
*
* @return this, as part of a fluent interface
*/
public BaseObjectInspectorConfig setActionStyle( ActionStyle actionStyle ) {
mActionStyle = actionStyle;
mNullActionStyle = ( actionStyle == null );
// Fluent interface
return this;
}
@Override
public boolean equals( Object that ) {
if ( this == that ) {
return true;
}
if ( !ObjectUtils.nullSafeClassEquals( this, that ) ) {
return false;
}
if ( !ObjectUtils.nullSafeEquals( mPropertyStyle, ( (BaseObjectInspectorConfig) that ).mPropertyStyle ) ) {
return false;
}
if ( mNullPropertyStyle != ( (BaseObjectInspectorConfig) that ).mNullPropertyStyle ) {
return false;
}
if ( !ObjectUtils.nullSafeEquals( mActionStyle, ( (BaseObjectInspectorConfig) that ).mActionStyle ) ) {
return false;
}
if ( mNullActionStyle != ( (BaseObjectInspectorConfig) that ).mNullActionStyle ) {
return false;
}
return true;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + ObjectUtils.nullSafeHashCode( mPropertyStyle );
hashCode = 31 * hashCode + ObjectUtils.nullSafeHashCode( mNullPropertyStyle );
hashCode = 31 * hashCode + ObjectUtils.nullSafeHashCode( mActionStyle );
hashCode = 31 * hashCode + ObjectUtils.nullSafeHashCode( mNullActionStyle );
return hashCode;
}
//
// Protected methods
//
/**
* Gets the style used to recognize properties.
*/
protected PropertyStyle getPropertyStyle() {
if ( mPropertyStyle == null && !mNullPropertyStyle ) {
// Do not initialise unless needed, so that we can be shipped without
if ( DEFAULT_PROPERTY_STYLE == null ) {
DEFAULT_PROPERTY_STYLE = new JavaBeanPropertyStyle();
}
return DEFAULT_PROPERTY_STYLE;
}
return mPropertyStyle;
}
/**
* Gets the style used to recognize actions.
*/
protected ActionStyle getActionStyle() {
if ( mActionStyle == null && !mNullActionStyle ) {
// Do not initialise unless needed, so that we can be shipped without
if ( DEFAULT_ACTION_STYLE == null ) {
try {
DEFAULT_ACTION_STYLE = (ActionStyle) Class.forName( ActionStyle.class.getPackage().getName() + ".metawidget.MetawidgetActionStyle" ).newInstance();
} catch ( ClassNotFoundException e ) {
// Some environments might choose to ship without MetawidgetActionStyle
} catch ( InstantiationException e ) {
// Some environments might choose to ship without MetawidgetActionStyle
} catch ( IllegalAccessException e ) {
// Some environments might choose to ship without MetawidgetActionStyle
}
}
return DEFAULT_ACTION_STYLE;
}
return mActionStyle;
}
}