View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.myfaces.trinidad.util.ref;
20  
21  import java.lang.ref.ReferenceQueue;
22  import java.lang.ref.SoftReference;
23  
24  /**
25   * <p>
26   * PseudoReferenceFactory for creating SoftReference PseudoReferences to Objects.
27   * </p>
28   */
29  public final class SoftPseudoReferenceFactory<T> extends PseudoReferenceFactory<T>
30  {
31    /**
32     * Creates and returns a StrongPseudoReference to the referent
33     * @param referent
34     * @param queue Optional attribute specifying the ReferenceQueue to use for the created
35     * PseudoReference.  If the PseudoReference doesn't support ReferenceQueues, this attribute
36     * will be ignored
37     * @return the created PseudoReference
38     */
39    @Override
40    public PseudoReference<T> create(T referent, ReferenceQueue<? super T> queue)
41    {
42      return new ReferencePseudoReference<T>(new SoftReference<T>(referent, queue));
43    }
44  }