org.apache.tomcat.util.digester.ObjectCreationFactory Maven / Gradle / Ivy
/*
* 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.tomcat.util.digester;
import org.xml.sax.Attributes;
/**
* Interface for use with {@link FactoryCreateRule}.
* The rule calls {@link #createObject} to create an object
* to be pushed onto the Digester stack
* whenever it is matched.
*
* {@link AbstractObjectCreationFactory} is an abstract
* implementation suitable for creating anonymous
* ObjectCreationFactory implementations.
*/
public interface ObjectCreationFactory {
/**
* Factory method called by {@link FactoryCreateRule} to supply an
* object based on the element's attributes.
*
* @param attributes the element's attributes
* @return the created object
* @throws Exception any exception thrown will be propagated upwards
*/
public Object createObject(Attributes attributes) throws Exception;
/**
* @return the {@link Digester} that was set by the
* {@link FactoryCreateRule} upon initialization.
*/
public Digester getDigester();
/**
* Set the {@link Digester} to allow the implementation to do logging,
* classloading based on the digester's classloader, etc.
*
* @param digester parent Digester object
*/
public void setDigester(Digester digester);
}