/*
    * Copyright (c) 2002-2026 Gargoyle Software Inc.
    *
    * 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
    * https://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 org.htmlunit.util;
  
  import java.io.File;
  import java.io.IOException;
  import java.io.ObjectInputStream;
  import java.io.ObjectOutputStream;
  import java.nio.charset.Charset;
  
  /**
   * <span style="color:red">INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.</span><br>
   *
   * A holder for a key/value pair that represents a file to upload.
   *
   * @author Brad Clarke
   * @author David D. Kilzer
   * @author Mike Bowler
   * @author Ahmed Ashour
   * @author Ronald Brill
   * @author Michael Lueck
   */
  public class KeyDataPair extends NameValuePair {
  
      private final File fileObject_;
      private final String fileName_;
      private final String mimeType_;
      private transient Charset charset_;
      private byte[] data_;
  
      /**
       * Creates an instance.
       *
       * @param key the key
       * @param file the file
       * @param fileName the name of the file
       * @param mimeType the MIME type
       * @param charset the charset encoding name
       */
      public KeyDataPair(final String key, final File file, final String fileName,
              final String mimeType, final String charset) {
          this(key, file, fileName, mimeType, Charset.forName(charset));
      }
  
      /**
       * Creates an instance.
       *
       * @param key the key
       * @param file the file
       * @param fileName the name of the file
       * @param mimeType the MIME type
       * @param charset the charset encoding
       */
      public KeyDataPair(final String key, final File file, final String fileName,
              final String mimeType, final Charset charset) {
          this(key,
                (file == null) ? "" : file.getName(),
                (file != null && file.exists()) ? file : null,
                fileName,
                mimeType,
                charset,
                null);
      }
  
      /**
       * Private constructor setting all fields directly.
       *
       * @param name passed as the name to the super constructor
       * @param value passed as the value to the super constructor
       * @param file the file, may be {@code null}
       * @param fileName the filename, may be {@code null}
       * @param mimeType the MIME type, may be {@code null}
       * @param charset the charset, may be {@code null}
       * @param data the in-memory file data, may be {@code null}
       */
      private KeyDataPair(final String name, final String value, final File file,
                final String fileName, final String mimeType, final Charset charset,
                final byte[] data) {
          super(name, value);
  
          fileObject_ = file;
          fileName_ = fileName;
  
          mimeType_ = mimeType;
          charset_ = charset;
  
          data_ = data;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings("PMD.UselessOverridingMethod")
     public boolean equals(final Object object) {
         // this is overwritten to make FindBugs happy
         // and to make it clear, that we really want to have
         // the same equals semantic like our parent class
         return super.equals(object);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings("PMD.UselessOverridingMethod")
     public int hashCode() {
         // this is overwritten to make FindBugs happy
         // and to make it clear, that we really want to have
         // the same hashCode as our parent class
         return super.hashCode();
     }
 
     /**
      * Returns the {@link File} object if the file exists, otherwise {@code null}.
      *
      * @return the file, or {@code null} if it does not exist
      */
     public File getFile() {
         return fileObject_;
     }
 
     /**
      * Returns the file name.
      *
      * @return the file name
      */
     public String getFileName() {
         return fileName_;
     }
 
     /**
      * Returns the charset encoding for this file upload.
      *
      * @return the charset
      */
     public Charset getCharset() {
         return charset_;
     }
 
     /**
      * Returns the MIME type for this file upload.
      *
      * @return the MIME type
      */
     public String getMimeType() {
         return mimeType_;
     }
 
     /**
      * Returns the in-memory data assigned to this file value,
      * or {@code null} if the actual file content should be used.
      *
      * @return the in-memory data, or {@code null}
      */
     public byte[] getData() {
         return data_;
     }
 
     /**
      * Sets the in-memory data for this file value.
      * If not set, the file content will be used.
      *
      * @param data the byte array with file data
      */
     public void setData(final byte[] data) {
         data_ = data;
     }
 
     private void writeObject(final ObjectOutputStream oos) throws IOException {
         oos.defaultWriteObject();
         oos.writeObject(charset_ == null ? null : charset_.name());
     }
 
     private void readObject(final ObjectInputStream ois) throws ClassNotFoundException, IOException {
         ois.defaultReadObject();
         final String charsetName = (String) ois.readObject();
         if (charsetName != null) {
             charset_ = Charset.forName(charsetName);
         }
     }
 
     /**
      * {@inheritDoc}
      *
      * Specialization of the inherited method that copies all fields
      * and ensures the value in the base class is not {@code null}.
      */
     @Override
     public KeyDataPair normalized() {
         return new KeyDataPair(
             this.getName(),
             this.getValue(),
             this.fileObject_,
             this.fileName_,
             this.mimeType_,
             this.charset_,
             this.data_);
     }
 }