FinalParameterContainer.java

/*
** Module   : FinalParameterContainer.java
** Abstract : holds an objects for use with lambdas / inner classes 
**
** Copyright (c) 2022, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description---------------------------------------
** 001 OM  20221220 Created initial version.
*/

/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
** 
** Additional terms under GNU Affero GPL version 3 section 7:
** 
**   Under Section 7 of the GNU Affero GPL version 3, the following additional
**   terms apply to the works covered under the License.  These additional terms
**   are non-permissive additional terms allowed under Section 7 of the GNU
**   Affero GPL version 3 and may not be removed by you.
** 
**   0. Attribution Requirement.
** 
**     You must preserve all legal notices or author attributions in the covered
**     work or Appropriate Legal Notices displayed by works containing the covered
**     work.  You may not remove from the covered work any author or developer
**     credit already included within the covered work.
** 
**   1. No License To Use Trademarks.
** 
**     This license does not grant any license or rights to use the trademarks
**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
**     of Golden Code Development Corporation. You are not authorized to use the
**     name Golden Code, FWD, or the names of any author or contributor, for
**     publicity purposes without written authorization.
** 
**   2. No Misrepresentation of Affiliation.
** 
**     You may not represent yourself as Golden Code Development Corporation or FWD.
** 
**     You may not represent yourself for publicity purposes as associated with
**     Golden Code Development Corporation, FWD, or any author or contributor to
**     the covered work, without written authorization.
** 
**   3. No Misrepresentation of Source or Origin.
** 
**     You may not represent the covered work as solely your work.  All modified
**     versions of the covered work must be marked in a reasonable way to make it
**     clear that the modified work is not originating from Golden Code Development
**     Corporation or FWD.  All modified versions must contain the notices of
**     attribution required in this license.
*/
package com.goldencode.p2j.util;

/**
 * Objects of this class are used when a non-final object which must be accessed from a lambda/inner class.
 * The container is not mandatory to be explicitly final, the natural usage make them effective final which
 * is accepted by recent Java versions. Use the setter and getters to access and alter the desired object.
 */
public final class FinalParameterContainer<T>
{
   /** The object which cannot be final. */
   private T value;
   
   /**
    * The constructor takes the non-final object and stores it internally.
    *
    * @param   value
    *          The non-final object.
    */
   public FinalParameterContainer(T value)
   {
      this.value = value;
   }
   
   /**
    * Getter for contained object. Can be accessed from both lambda/inner class and also from parent class.
    * 
    * @return  the stored object.
    */
   public T getValue()
   {
      return value;
   }
   
   /**
    * Setter for contained object.
    *
    * @param   value
    *          The new value to be stored in the container. Usually called from lambda/inner-class
    */
   public void setValue(T value)
   {
      this.value = value;
   }
}