001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.proxy2.provider;
019
020import java.io.Serializable;
021
022import org.apache.commons.proxy2.ObjectProvider;
023
024/**
025 * Always returns the same object.
026 * 
027 * @since 1.0
028 */
029public class ConstantProvider<T> implements ObjectProvider<T>, Serializable
030{
031    /** Serialization version */
032    private static final long serialVersionUID = 1L;
033
034    //******************************************************************************************************************
035    // Fields
036    //******************************************************************************************************************
037
038    private final T constant;
039
040    //******************************************************************************************************************
041    // Constructors
042    //******************************************************************************************************************
043
044    /**
045     * Create a new ConstantProvider instance.
046     * 
047     * @param constant
048     */
049    public ConstantProvider(T constant)
050    {
051        this.constant = constant;
052    }
053
054    //******************************************************************************************************************
055    // ObjectProvider Implementation
056    //******************************************************************************************************************
057
058    /**
059     * {@inheritDoc}
060     */
061    @Override
062    public T getObject()
063    {
064        return constant;
065    }
066}