org.metawidget.inspector.impl.actionstyle.MethodActionStyle 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.actionstyle;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.Map;
import org.metawidget.util.CollectionUtils;
/**
* Convenience ActionStyle implementation for Method-based actions.
*
* @author Richard Kennard
*/
public abstract class MethodActionStyle
extends BaseActionStyle {
//
// Protected methods
//
/**
* @return the actions of the given class. Never null.
*/
@Override
protected Map inspectActions( Class clazz ) {
// TreeMap so that returns alphabetically sorted actions
Map actions = CollectionUtils.newTreeMap();
// For each action...
for ( Method method : clazz.getMethods() ) {
// ...that is a match...
if ( !matchAction( method ) ) {
continue;
}
// ...that is not excluded...
if ( isExcluded( method ) ) {
continue;
}
// ...add it
String methodName = method.getName();
actions.put( methodName, new MethodAction( methodName, method ) );
}
return actions;
}
/**
* Whether to exclude the given method when searching for actions.
*
* This can be useful when the convention or base class define methods that are
* framework-specific, and should be filtered out from 'real' business model methods.
*
* By default, does not exclude any methods.
*
* @param method
* method to consider excluding
* @return true if the property should be excluded, false otherwise
*/
protected boolean isExcluded( Method method ) {
return false;
}
protected abstract boolean matchAction( Method method );
//
// Inner classes
//
/**
* Method-based action.
*/
protected static class MethodAction
extends BaseAction {
//
// Private methods
//
private Method mMethod;
//
// Constructor
//
public MethodAction( String name, Method method ) {
super( name );
mMethod = method;
if ( mMethod == null ) {
throw new NullPointerException( "method" );
}
}
//
// Public methods
//
public T getAnnotation( Class annotation ) {
return mMethod.getAnnotation( annotation );
}
}
}