/* $Id: FromAnnotationRuleProviderFactory.java 992060 2010-09-02 19:09:47Z simonetripodi $
*
* 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.
*/
package org.apache.commons.digester.annotations;
import org.apache.commons.digester.annotations.internal.DefaultDigesterLoaderHandlerFactory;
import org.apache.commons.digester.annotations.spi.AnnotationRuleProviderFactory;
import org.apache.commons.digester.annotations.spi.DigesterLoaderHandlerFactory;
DigesterLoader
builder implementation. Since: 2.1
/**
* {@link DigesterLoader} builder implementation.
*
* @since 2.1
*/
public final class FromAnnotationRuleProviderFactory {
The AnnotationRuleProviderFactory
selected in the previous chained builder. /**
* The {@link AnnotationRuleProviderFactory} selected in the previous
* chained builder.
*/
private final AnnotationRuleProviderFactory annotationRuleProviderFactory;
DigesterLoader
builder implementation. Params: - annotationRuleProviderFactory – the
AnnotationRuleProviderFactory
selected in the previous chained builder.
/**
* {@link DigesterLoader} builder implementation.
*
* @param annotationRuleProviderFactory the
* {@link AnnotationRuleProviderFactory} selected in the previous
* chained builder.
*/
protected FromAnnotationRuleProviderFactory(
AnnotationRuleProviderFactory annotationRuleProviderFactory) {
this.annotationRuleProviderFactory = annotationRuleProviderFactory;
}
Builds a new DigesterLoader
using the default DigesterLoaderHandlerFactory
implementation. Returns: the DigesterLoader
.
/**
* Builds a new {@link DigesterLoader} using the default
* {@link DigesterLoaderHandlerFactory} implementation.
*
* @return the {@link DigesterLoader}.
*/
public DigesterLoader useDefaultDigesterLoaderHandlerFactory() {
return this.useDigesterLoaderHandlerFactory(new DefaultDigesterLoaderHandlerFactory());
}
Builds a new DigesterLoader
using the user defined DigesterLoaderHandlerFactory
implementation. Params: - digesterLoaderHandlerFactory –
Returns: the DigesterLoader
.
/**
* Builds a new {@link DigesterLoader} using the user defined
* {@link DigesterLoaderHandlerFactory} implementation.
*
* @param digesterLoaderHandlerFactory
* @return the {@link DigesterLoader}.
*/
public DigesterLoader useDigesterLoaderHandlerFactory(DigesterLoaderHandlerFactory digesterLoaderHandlerFactory) {
if (digesterLoaderHandlerFactory == null) {
throw new IllegalArgumentException("Parameter 'digesterLoaderHandlerFactory' must be not null");
}
return new DigesterLoader(this.annotationRuleProviderFactory, digesterLoaderHandlerFactory);
}
}