/*
    * GordianKnot: Security Suite
    * Copyright 2026. Tony Washer
    *
    * Licensed under the Apache License, Version 2.0 (the "License"); you may not
    * use this file except in compliance with the License.  You may obtain a copy
    * of the License at
    *
    *   http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
   * License for the specific language governing permissions and limitations under
   * the License.
   */
  
  package io.github.tonywasher.joceanus.gordianknot.impl.ext.params;
  
  import org.bouncycastle.crypto.params.SkeinParameters;
  
  import java.util.Date;
  import java.util.Enumeration;
  import java.util.Hashtable;
  import java.util.Locale;
  
  /**
   * Extended Skein Parameters.
   */
  public class GordianSkeinParameters
          extends SkeinParameters {
      /**
       * The maximum xofLen.
       */
      private long theMaxXofLen;
  
      /**
       * The fanOut.
       */
      private short theFanOut;
  
      /**
       * The maxDepth.
       */
      private short theMaxDepth;
  
      /**
       * The leafLength.
       */
      private int theLeafLen;
  
      /**
       * Obtain the maximum output length.
       *
       * @return the output length
       */
      public long getMaxOutputLength() {
          return theMaxXofLen;
      }
  
      /**
       * Obtain the treeLeafLength.
       *
       * @return the leafLength
       */
      public int getTreeLeafLen() {
          return theLeafLen;
      }
  
      /**
       * Obtain the treeFanOut.
       *
       * @return the fanOut
       */
      public short getTreeFanOut() {
          return theFanOut;
      }
  
      /**
       * Obtain the treeMaxDepth.
       *
       * @return the maxDepth
       */
      public short getTreeMaxDepth() {
          return theMaxDepth;
      }
  
      /**
       * A builder for {@link GordianSkeinParameters}.
       */
      public static class GordianSkeinParametersBuilder
              extends SkeinParameters.Builder {
          /**
           * The maximum xofLen.
           */
          private long theMaxXofLen;
  
          /**
           * The fanOut.
          */
         private short theFanOut;
 
         /**
          * The maxDepth.
          */
         private short theMaxDepth;
 
         /**
          * The leafLength.
          */
         private int theLeafLen;
 
         @Override
         public GordianSkeinParametersBuilder set(final int type,
                                                  final byte[] value) {
             return (GordianSkeinParametersBuilder) super.set(type, value);
         }
 
         @Override
         public GordianSkeinParametersBuilder setKey(final byte[] key) {
             return (GordianSkeinParametersBuilder) super.setKey(key);
         }
 
         @Override
         public GordianSkeinParametersBuilder setPersonalisation(final byte[] personalisation) {
             return (GordianSkeinParametersBuilder) super.setPersonalisation(personalisation);
         }
 
         @Override
         public GordianSkeinParametersBuilder setPersonalisation(final Date date,
                                                                 final String emailAddress,
                                                                 final String distinguisher) {
             return (GordianSkeinParametersBuilder) super.setPersonalisation(date, emailAddress, distinguisher);
         }
 
         @Override
         public GordianSkeinParametersBuilder setPersonalisation(final Date date,
                                                                 final Locale dateLocale,
                                                                 final String emailAddress,
                                                                 final String distinguisher) {
             return (GordianSkeinParametersBuilder) super.setPersonalisation(date, dateLocale, emailAddress, distinguisher);
         }
 
         @Override
         public GordianSkeinParametersBuilder setPublicKey(final byte[] publicKey) {
             return (GordianSkeinParametersBuilder) super.setPublicKey(publicKey);
         }
 
         @Override
         public GordianSkeinParametersBuilder setKeyIdentifier(final byte[] keyId) {
             return (GordianSkeinParametersBuilder) super.setKeyIdentifier(keyId);
         }
 
         @Override
         public GordianSkeinParametersBuilder setNonce(final byte[] nonce) {
             return (GordianSkeinParametersBuilder) super.setNonce(nonce);
         }
 
         /**
          * Set the maximum output length. (-1=unlimited, 0=underlying)
          *
          * @param pMaxOutLen the maximum output length
          * @return the Builder
          */
         public GordianSkeinParametersBuilder setMaxOutputLen(final long pMaxOutLen) {
             theMaxXofLen = pMaxOutLen;
             return this;
         }
 
         /**
          * Set the treeConfig.
          *
          * @param pFanOut   the fanOut (powers of two - 1-255).
          * @param pMaxDepth the maxDepth (2-255).
          * @param pLeafLen  the leafLength (powers of two times outputLength - 1-255).
          * @return the Builder
          */
         public GordianSkeinParametersBuilder setTreeConfig(final int pFanOut,
                                                            final int pMaxDepth,
                                                            final int pLeafLen) {
             theFanOut = (short) pFanOut;
             theMaxDepth = (short) pMaxDepth;
             theLeafLen = pLeafLen;
             return this;
         }
 
         @Override
         @SuppressWarnings("unchecked")
         public GordianSkeinParameters build() {
             /* Build base parameters */
             final SkeinParameters myBaseParms = super.build();
             final GordianSkeinParameters myParams = new GordianSkeinParameters();
 
             /* Store base details */
             final Hashtable<Integer, Object> myBaseStore = myBaseParms.getParameters();
             final Hashtable<Integer, Object> myStore = myParams.getParameters();
             final Enumeration<Integer> keys = myBaseStore.keys();
             while (keys.hasMoreElements()) {
                 final Integer key = keys.nextElement();
                 myStore.put(key, myBaseStore.get(key));
             }
 
             /* Record XofDetails */
             myParams.theMaxXofLen = theMaxXofLen;
 
             /* Record tree details */
             myParams.theFanOut = theFanOut;
             myParams.theMaxDepth = theMaxDepth;
             myParams.theLeafLen = theLeafLen;
             return myParams;
         }
     }
 }