jakarta.faces.view.facelets.TagHandlerDelegateFactory Maven / Gradle / Ivy
Show all versions of jakarta.faces Show documentation
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.faces.view.facelets;
import jakarta.faces.FacesWrapper;
/**
*
* Abstract factory for creating instances of
* {@link TagHandlerDelegate}.
*
*
*
* Usage: extend this class and push the implementation being wrapped to the constructor and use {@link #getWrapped} to
* access the instance being wrapped.
*
*
* @since 2.0
*/
public abstract class TagHandlerDelegateFactory implements FacesWrapper {
private TagHandlerDelegateFactory wrapped;
/**
* @deprecated Use the other constructor taking the implementation being wrapped.
*/
@Deprecated
public TagHandlerDelegateFactory() {
}
/**
*
* If this factory has been decorated, the implementation doing the decorating should push the implementation being
* wrapped to this constructor. The {@link #getWrapped()} will then return the implementation being wrapped.
*
*
* @param wrapped The implementation being wrapped.
*/
public TagHandlerDelegateFactory(TagHandlerDelegateFactory wrapped) {
this.wrapped = wrapped;
}
/**
*
* If this factory has been decorated, the implementation doing the decorating may override this method to provide
* access to the implementation being wrapped.
*
*
* @since 2.2
*/
@Override
public TagHandlerDelegateFactory getWrapped() {
return wrapped;
}
/**
*
* Create and return a {@link TagHandlerDelegate} instance designed for use with {@link ComponentHandler}.
*
*
* @param owner the ComponentHandler
instance being helped by this helper instance.
*
* @return the newly created instance
*
* @since 2.0
*/
public abstract TagHandlerDelegate createComponentHandlerDelegate(ComponentHandler owner);
/**
*
* Create and return a {@link TagHandlerDelegate} instance designed for use with {@link ValidatorHandler}.
*
*
* @param owner the ValidatorHandler
instance being helped by this helper instance.
*
* @return the newly created instance
*
* @since 2.0
*/
public abstract TagHandlerDelegate createValidatorHandlerDelegate(ValidatorHandler owner);
/**
*
* Create and return a {@link TagHandlerDelegate} instance designed for use with {@link ConverterHandler}.
*
*
* @param owner the ValidatorHandler
instance being helped by this helper instance.
*
* @return the newly created instance
*
* @since 2.0
*/
public abstract TagHandlerDelegate createConverterHandlerDelegate(ConverterHandler owner);
/**
*
* Create and return a {@link TagHandlerDelegate} instance designed for use with {@link BehaviorHandler}.
*
*
* @param owner the ValidatorHandler
instance being helped by this helper instance.
*
* @return the newly created instance
*
* @since 2.0
*/
public abstract TagHandlerDelegate createBehaviorHandlerDelegate(BehaviorHandler owner);
}