001// Copyright 2006, 2011 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007// http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry5.internal.transform;
016
017import org.apache.tapestry5.annotations.Retain;
018import org.apache.tapestry5.model.MutableComponentModel;
019import org.apache.tapestry5.plastic.PlasticClass;
020import org.apache.tapestry5.plastic.PlasticField;
021import org.apache.tapestry5.services.transform.ComponentClassTransformWorker2;
022import org.apache.tapestry5.services.transform.TransformationSupport;
023
024/**
025 * Identifies fields with the {@link org.apache.tapestry5.annotations.Retain} annotation, and "claims" them so that no
026 * special work will occur on them. Retain has been deprecated in Tapestry 5.2 and will likely be removed in the future.
027 */
028public final class RetainWorker implements ComponentClassTransformWorker2
029{
030    /**
031     * Claims each field with the {@link org.apache.tapestry5.annotations.Retain}  , claiming it using the
032     * annotation class (not the annotation instance, to avoid
033     * instantiating the annotation) as the tag.
034     */
035    public void transform(PlasticClass plasticClass, TransformationSupport support, MutableComponentModel model)
036    {
037        for (PlasticField field : plasticClass.getFieldsWithAnnotation(Retain.class))
038        {
039            field.claim(Retain.class);
040        }
041    }
042}