WeightFactor.java

/*
** Module   : WeightFactor.java
** Abstract : An enum defining the possible weights to be set for context-local vars.
**
** Copyright (c) 2014-2022, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description---------------------------------------
** 001 CA  20140520 Created initial version.
** 002 CA  20150228 Added FIRST, for vars which need to be cleaned up before anything else.
** 003 OM  20211013 Added integer values.
**     CA  20220120 Added array size for storing presorted finalizables.
*/

/*
** 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.security;

/**
 * Enum defining the possible weight factors for context-local vars.  During context cleanup or reset, the
 * context-local tokens will be processed by the order provided by these factors.
 * <p>
 * If needed, add new levels in front of the {@link #LAST} level, as vars set to this level need to be cleaned
 * last. The assigned values MUST be consecutive, in ascending order because they are used as array indices.
 * The value of {@code LAST} must be reassigned so it is the maximum value of all previous enum constants.
 */
public enum WeightFactor
{
   /**
    * Objects with this weight have no direct dependency. They can be processed at any time.
    * <p>
    * Note: why are they sorted first?
    */
   NO_DEPENDENCY(-1),
   
   /** Objects with this weight will always be processed first.*/
   FIRST(0),
   
   LEVEL_1(1),
   LEVEL_2(2),
   LEVEL_3(3),
   LEVEL_4(4),
   LEVEL_5(5),
   LEVEL_6(6),
   LEVEL_7(7),
   LEVEL_8(8),
   LEVEL_9(9),
   LEVEL_10(10),
   
   /** Objects with this weight will always be processed last.*/
   LAST(11),
   ;
   
   /** The size of an array which can hold finalizables of each weight. */
   public static final int WEIGHTS_ARRAY_SIZE = LAST.value + 3;
   
   /**
    * The integer value of this literal constant. Although the values are allocated in the ascending order,
    * the Java's sorting algorithm will ignore this value unless {@code getValue()} accessor is specified.
    */
   private final int value;
   
   /**
    * The constructor initializes the internal integer value.
    * 
    * @param   intVal
    *          The integer value represented by this enum literal. 
    */
   WeightFactor(int intVal)
   {
      this.value = intVal;
   }
   
   /**
    * Obtain the value this enum constant represents.
    * 
    * @return  the value this enum constant represents.
    */
   public int getValue()
   {
      return value;
   }
   
   /**
    * Get the index when storing finalizables in an array, persorted.
    */
   public int getIndex()
   {
      return value + 1;
   }
}