StartupParameter.java

/*
** Module   : StartupParameter.java
** Abstract : Abstract startup parameter class
**
** Copyright (c) 2023-2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- ----------------------------------Description---------------------------------
** 001 TT  20230915 Created initial version.
** 002 VVT 20241202 Missing Javadocs paramter description added. Import code section organized.
*/

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

import java.io.*;

import com.goldencode.p2j.cfg.*;

/**
 * This abstract class encapsulates the common functionality for startup parameters of different types.
 * 
 * @param <T> the parameter typer defined by subclasses.
 */
public abstract class StartupParameter<T>
{
   /** This is the actual value of the startup parameter */
   T value;

   /** This is the parameter prefix used in FWD. */
   final String prefix;

   /** This is the parameter name used in FWD. */
   final String name;

   /** This is the original name used by OE. */
   final String originalName;

   /**
    * This is the default constructor.
    *
    * @param name is the parameter name used by FWD.
    * @param originalName is the original name used by OE.
    */
   public StartupParameter(String name, String originalName)
   {
      this.prefix = null;
      this.name = name;
      this.originalName = originalName;
   }

   /**
    * This is the default constructor.
    *
    * @param prefix is the parameter name prefix used by FWD.
    * @param name is the parameter name used by FWD.
    * @param originalName is the original name used by OE.
    */
   public StartupParameter(String prefix, String name, String originalName)
   {
      this.prefix = prefix;
      this.name = name;
      this.originalName = originalName;
   }

   /**
    * Getter for the parameter vale.
    *
    * @return the parameter value.
    */
   public T getValue()
   {
      return value;
   }

   /** Initialize the parameter from the {@link DirectoryService}. */
   public abstract void initFromDirectory();

   /**
    * Initialize the parameter from the {@link BootstrapConfig}
    *
    * @param bootstrapConfig is the bootstrap configuration.
    */
   public abstract void initFromBootstrap(BootstrapConfig bootstrapConfig);

   /**
    * Used for helping with {@link Externalizable#readExternal(ObjectInput)}
    *
    * @param in the stream to read data from in order to restore the object
    * @exception IOException if I/O errors occur
    */
   public abstract void readExternal(ObjectInput in) throws IOException;

   /**
    * Used for helping with {@link Externalizable#writeExternal(ObjectOutput)}
    *
    * @param out the stream to write the object to
    * @exception IOException Includes any I/O exceptions that may occur
    */
   public abstract void writeExternal(ObjectOutput out) throws IOException;

   /**
    * Overrides te default {@link Object#toString()} method. If the value is null, it returns null.
    *
    * @return a string containing the original name and the value.
    */
   @Override
   public String toString()
   {
      return value == null ? null : originalName + " " + value;
   }
}