View Javadoc
1   /**
2    * Copyright 2005-2014 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.krad.uif.lifecycle;
17  
18  import org.kuali.rice.krad.uif.util.RecycleUtils;
19  
20  /**
21   * Responsible for creating lifecycle phases.
22   *
23   * <p>This factory recycles completed phases to reduce object creation during the lifecycle.</p>
24   *
25   * @author Kuali Rice Team (rice.collab@kuali.org)
26   */
27  public final class LifecyclePhaseFactory {
28  
29      /**
30       * Private constructor - utility class only.
31       */
32      private LifecyclePhaseFactory() {}
33  
34      /**
35       * Build a phase instance for processing the given view phase.
36       * 
37       * @param viewPhase view phase
38       * @return phase instance
39       */
40      @SuppressWarnings("unchecked")
41      public static <T extends ViewLifecyclePhase> T buildPhase(String viewPhase) {
42          return RecycleUtils.<T> getInstance("ViewLifecyclePhase-"+viewPhase, (Class<T>) ViewLifecyclePhase.class);
43      }
44      
45      /**
46       * Recycles a task instance after processing.
47       *
48       * @param phase The task to recycle.
49       */
50      static void recycle(ViewLifecyclePhase phase) {
51          phase.recycle();
52          RecycleUtils.recycle(phase);
53      }
54  
55  }