org.metawidget.inspector.impl.propertystyle.BasePropertyStyleConfig Maven / Gradle / Ivy
// Metawidget
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
package org.metawidget.inspector.impl.propertystyle;
import java.util.regex.Pattern;
import org.metawidget.util.simple.ObjectUtils;
/**
* Base class for BasePropertyStyle configurations.
*
* @author Richard Kennard
*/
public class BasePropertyStyleConfig {
//
// Private statics
//
private static Pattern DEFAULT_EXCLUDE_BASE_TYPE;
//
// Private members
//
private boolean mCacheProperties = true;
private Pattern mExcludeBaseType;
private boolean mNullExcludeBaseType;
//
// Public methods
//
/**
* Sets whether to cache property lookups for a class. In general, looking up properties is
* expensive and its results are static, so caching can greatly improve performance. However it
* may be useful to disable caching for debugging purposes or for dynamic classes.
*
* True by default.
*
* @return this, as part of a fluent interface
*/
public BasePropertyStyleConfig setCacheProperties( boolean cacheProperties ) {
mCacheProperties = cacheProperties;
// Fluent interface
return this;
}
/**
* Sets the Pattern used to exclude base types when searching up the model inheritance chain.
*
* This can be useful when the base types define properties that are framework-specific, and
* should be filtered out from 'real' business model properties.
*
* By default, excludes any base types from java.* or javax.*.
*
* @return this, as part of a fluent interface
*/
public BasePropertyStyleConfig setExcludeBaseType( Pattern excludeBaseType ) {
mExcludeBaseType = excludeBaseType;
if ( excludeBaseType == null ) {
mNullExcludeBaseType = true;
}
// Fluent interface
return this;
}
@Override
public boolean equals( Object that ) {
if ( this == that ) {
return true;
}
if ( !ObjectUtils.nullSafeClassEquals( this, that )) {
return false;
}
if ( mCacheProperties != ( (BasePropertyStyleConfig) that ).mCacheProperties ) {
return false;
}
if ( !ObjectUtils.nullSafeEquals( mExcludeBaseType, ( (BasePropertyStyleConfig) that ).mExcludeBaseType ) ) {
return false;
}
if ( mNullExcludeBaseType != ( (BasePropertyStyleConfig) that ).mNullExcludeBaseType ) {
return false;
}
return true;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + ObjectUtils.nullSafeHashCode( mCacheProperties );
hashCode = 31 * hashCode + ObjectUtils.nullSafeHashCode( mExcludeBaseType );
hashCode = 31 * hashCode + ObjectUtils.nullSafeHashCode( mNullExcludeBaseType );
return hashCode;
}
//
// Protected methods
//
protected boolean isCacheProperties() {
return mCacheProperties;
}
protected Pattern getExcludeBaseType() {
if ( mExcludeBaseType == null && !mNullExcludeBaseType ) {
if ( DEFAULT_EXCLUDE_BASE_TYPE == null ) {
DEFAULT_EXCLUDE_BASE_TYPE = Pattern.compile( "^(java|javax)\\..*$" );
}
return DEFAULT_EXCLUDE_BASE_TYPE;
}
return mExcludeBaseType;
}
}