com.feilong.lib.digester3.binder.AbstractParamTypeBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation
feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.
There is a newer version: 4.0.8
Show newest version
package com.feilong.lib.digester3.binder;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import static java.lang.String.format;

import com.feilong.lib.digester3.AbstractMethodRule;

/**
 * Builder chained when invoking {@link LinkedRuleBuilder#setNext(String)},
 * {@link LinkedRuleBuilder#setRoot(String)} or {@link LinkedRuleBuilder#setTop(String)}.
 *
 * @param 
 *            any {@link AbstractMethodRule} concrete implementation, typically
 *            {@link com.feilong.lib.digester3.SetNextRule}, {@link com.feilong.lib.digester3.SetRootRule}
 *            and {@link com.feilong.lib.digester3.SetTopRule}
 * @since 3.0
 */
public abstract class AbstractParamTypeBuilder extends AbstractBackToLinkedRuleBuilder{

    private final String      methodName;

    private final ClassLoader classLoader;

    private boolean           useExactMatch = false;

    private Class          paramType;

    private boolean           fireOnBegin   = false;

    AbstractParamTypeBuilder(String keyPattern, String namespaceURI, RulesBinder mainBinder, LinkedRuleBuilder mainBuilder,
                    String methodName, ClassLoader classLoader){
        super(keyPattern, namespaceURI, mainBinder, mainBuilder);
        this.methodName = methodName;
        this.classLoader = classLoader;
    }

    /**
     * Sets the Java class of the method's argument.
     * 
     * If you wish to use a primitive type, specify the corresonding
     * Java wrapper class instead, such as {@code java.lang.Boolean}
     * for a {@code boolean} parameter.
     *
     * @param paramType
     *            The Java class of the method's argument
     * @return this builder instance
     */
    public final AbstractParamTypeBuilder withParameterType(Class paramType){
        if (paramType == null){
            reportError(format(".%s.withParameterType( Class )", methodName), "NULL Java type not allowed");
            return this;
        }
        this.paramType = paramType;
        return withParameterType(paramType.getName());
    }

    /**
     * Sets the Java class name of the method's argument.
     * 
     * If you wish to use a primitive type, specify the corresonding
     * Java wrapper class instead, such as {@code java.lang.Boolean}
     * for a {@code boolean} parameter.
     *
     * @param paramType
     *            The Java class name of the method's argument
     * @return this builder instance
     */
    public final AbstractParamTypeBuilder withParameterType(String paramType){
        if (paramType == null){
            reportError(format(".%s.withParameterType( Class )", methodName), "NULL Java type not allowed");
            return this;
        }

        if (this.paramType == null){
            try{
                this.paramType = classLoader.loadClass(paramType);
            }catch (ClassNotFoundException e){
                this.reportError(format(".%s.withParameterType( Class )", methodName), format("class '%s' cannot be load", paramType));
            }
        }
        return this;
    }

    /**
     * Sets exact matching being used.
     *
     * @param useExactMatch
     *            The exact matching being used
     * @return this builder instance
     */
    public final AbstractParamTypeBuilder useExactMatch(boolean useExactMatch){
        this.useExactMatch = useExactMatch;
        return this;
    }

    /**
     * Marks the rule be invoked when {@code begin} or {@code end} events match.
     *
     * @param fireOnBegin
     *            true, to invoke the rule at {@code begin}, false for {@code end}
     * @return this builder instance
     */
    public final AbstractParamTypeBuilder fireOnBegin(boolean fireOnBegin){
        this.fireOnBegin = fireOnBegin;
        return this;
    }

    final String getMethodName(){
        return methodName;
    }

    final Class getParamType(){
        return paramType;
    }

    final boolean isUseExactMatch(){
        return useExactMatch;
    }

    final boolean isFireOnBegin(){
        return fireOnBegin;
    }

}