/*
    * Copyright 2010-2013 smartics, Kronseder & Reiner GmbH
    *
    * 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 de.smartics.xml.encoding;
  
  import java.io.Serializable;
  
  /**
   * Provides the information detected from the given XML document.
   */
  public final class XmlDescriptor implements Serializable // NOPMD
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The class version identifier.
     */
    private static final long serialVersionUID = 1L;
  
    // --- members --------------------------------------------------------------
  
    /**
     * The detected XML version. May be <code>null</code>.
     *
     * @serial
     */
    private final String version;
  
    /**
     * The detected encoding. May be <code>null</code>.
     *
     * @serial
     */
    private final String encoding;
  
    /**
     * The detected public ID version. May be <code>null</code>.
     *
     * @serial
     */
    private final String publicId;
  
    /**
     * The detected system ID version. May be <code>null</code>.
     *
     * @serial
     */
    private final String systemId;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    private XmlDescriptor(final XmlDescriptor.Builder builder)
    {
      this.version = builder.version;
      this.encoding = builder.encoding;
      this.publicId = builder.publicId;
      this.systemId = builder.systemId;
    }
  
    // ****************************** Inner Classes *****************************
  
    /**
     * The builder for {@link XMLDescriptor} instances.
     */
    public static final class Builder
    {
      // ******************************** Fields ********************************
  
      // --- constants ----------------------------------------------------------
  
      // --- members ------------------------------------------------------------
  
      /**
       * The detected XML version.
       */
      private String version;
  
      /**
       * The detected encoding.
       */
      private String encoding;
  
      /**
      * The detected public ID version.
      */
     private String publicId;
 
     /**
      * The detected system ID version.
      */
     private String systemId;
 
     // ***************************** Initializer ******************************
 
     // ***************************** Constructors *****************************
 
     // ***************************** Inner Classes ****************************
 
     // ******************************** Methods *******************************
 
     // --- init ---------------------------------------------------------------
 
     // --- get&set ------------------------------------------------------------
 
     /**
      * Sets the detected XML version.
      *
      * @param version the detected XML version.
      * @return a reference to this builder instance.
      */
     public Builder withVersion(final String version)
     {
       this.version = version;
       return this;
     }
 
     /**
      * Sets the detected encoding.
      *
      * @param encoding the detected encoding.
      * @return a reference to this builder instance.
      */
     public Builder withEncoding(final String encoding)
     {
       this.encoding = encoding;
       return this;
     }
 
     /**
      * Sets the detected public ID version.
      *
      * @param publicId the detected public ID version.
      * @return a reference to this builder instance.
      */
     public Builder withPublicId(final String publicId)
     {
       this.publicId = publicId;
       return this;
     }
 
     /**
      * Sets the detected system ID version.
      *
      * @param systemId the detected system ID version.
      * @return a reference to this builder instance.
      */
     public Builder withSystemId(final String systemId)
     {
       this.systemId = systemId;
       return this;
     }
 
     // --- business -----------------------------------------------------------
 
     /**
      * Creates the instance upon the builder's data.
      *
      * @return the created instance.
      */
     public XmlDescriptor build()
     {
       return new XmlDescriptor(this);
     }
 
     // --- object basics ------------------------------------------------------
 
   }
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   /**
    * Returns the detected XML version.
    *
    * @return the detected XML version. May be <code>null</code>.
    */
   public String getVersion()
   {
     return version;
   }
 
   /**
    * Returns the detected encoding.
    *
    * @return the detected encoding. May be <code>null</code>.
    */
   public String getEncoding()
   {
     return encoding;
   }
 
   /**
    * Returns the detected public ID version.
    *
    * @return the detected public ID version. May be <code>null</code>.
    */
   public String getPublicId()
   {
     return publicId;
   }
 
   /**
    * Returns the detected system ID version.
    *
    * @return the detected system ID version. May be <code>null</code>.
    */
   public String getSystemId()
   {
     return systemId;
   }
 
   // --- business -------------------------------------------------------------
 
   /**
    * Checks if at least one piece of information has been provided.
    *
    * @return <code>false</code> if no information has been found,
    *         <code>true</code> if at least one piece of information has been
    *         found.
    */
   public boolean isAnyInformationProvided()
   {
     return publicId != null || systemId != null || version != null
            || encoding != null;
   }
 
   private boolean providesIdAndContentInfo()
   {
     return (publicId != null || systemId != null) && providesContentInfo();
   }
 
   private boolean providesContentInfo()
   {
     return version != null || encoding != null;
   }
 
   // --- object basics --------------------------------------------------------
 
   /* CHECKSTYLE:OFF */
   /**
    * {@inheritDoc}
    *
    * @see java.lang.Object#toString()
    */
   @Override
   public String toString() // NOPMD
   {
     final StringBuilder buffer = new StringBuilder(64);
 
     if (publicId != null)
     {
       buffer.append(publicId);
 
       if (systemId != null)
       {
         buffer.append('/');
       }
     }
 
     if (systemId != null)
     {
       buffer.append(systemId);
     }
 
     if (providesIdAndContentInfo())
     {
       buffer.append(' ');
     }
 
     if (providesContentInfo())
     {
       buffer.append("XML");
 
       if (version != null)
       {
         buffer.append(" version ").append(version);
       }
 
       if (encoding != null)
       {
         buffer.append(" encoded with ").append(encoding);
       }
     }
 
     if (isAnyInformationProvided())
     {
       buffer.append('.');
     }
     else
     {
       buffer.append("No information provided.");
     }
 
     return buffer.toString();
   }
   /* CHECKSTYLE:ON */
 }