View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.proxy2.provider;
19  
20  import java.io.Serializable;
21  
22  import org.apache.commons.proxy2.ObjectProvider;
23  
24  /**
25   * Always returns the same object.
26   * 
27   * @since 1.0
28   */
29  public class ConstantProvider<T> implements ObjectProvider<T>, Serializable
30  {
31      /** Serialization version */
32      private static final long serialVersionUID = 1L;
33  
34      //******************************************************************************************************************
35      // Fields
36      //******************************************************************************************************************
37  
38      private final T constant;
39  
40      //******************************************************************************************************************
41      // Constructors
42      //******************************************************************************************************************
43  
44      /**
45       * Create a new ConstantProvider instance.
46       * 
47       * @param constant
48       */
49      public ConstantProvider(T constant)
50      {
51          this.constant = constant;
52      }
53  
54      //******************************************************************************************************************
55      // ObjectProvider Implementation
56      //******************************************************************************************************************
57  
58      /**
59       * {@inheritDoc}
60       */
61      @Override
62      public T getObject()
63      {
64          return constant;
65      }
66  }