/*
    * Copyright 2012 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.ci.config.maven;
  
  import de.smartics.ci.config.hudson.ScmType;
  import de.smartics.util.lang.Arguments;
  import de.smartics.util.lang.BlankArgumentException;
  
  /**
   * Provides access to information of a Maven POM.
   */
  public final class MavenPom
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * The project's group identifier.
     */
    private String groupId;
  
    /**
     * The project's artifact identifier.
     */
    private String artifactId;
  
    /**
     * The project's description.
     */
    private String description;
  
    /**
     * The type of the SCM.
     */
    private ScmType scmType;
  
    /**
     * The URL to the SCM server of the given {@link #getScmType() type}.
     */
    private String scmUrl;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     */
    public MavenPom()
    {
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    /**
     * Returns the project's group identifier.
     *
     * @return the project's group identifier.
     */
    public String getGroupId()
    {
      return groupId;
    }
  
    /**
     * Sets the project's group identifier.
     *
     * @param groupId the project's group identifier.
     */
    public void setGroupId(final String groupId)
    {
      this.groupId = groupId;
    }
  
    /**
     * Returns the project's artifact identifier.
     *
    * @return the project's artifact identifier.
    */
   public String getArtifactId()
   {
     return artifactId;
   }
 
   /**
    * Sets the project's artifact identifier.
    *
    * @param artifactId the project's artifact identifier.
    */
   public void setArtifactId(final String artifactId)
   {
     this.artifactId = artifactId;
   }
 
   /**
    * Returns the project's description.
    *
    * @return the project's description.
    */
   public String getDescription()
   {
     return description;
   }
 
   /**
    * Sets the project's description.
    *
    * @param description the project's description.
    */
   public void setDescription(final String description)
   {
     this.description = description;
   }
 
   /**
    * Returns the type of the SCM.
    *
    * @return the type of the SCM.
    */
   public ScmType getScmType()
   {
     return scmType;
   }
 
   /**
    * Returns the URL to the SCM server of the given {@link #getScmType() type}.
    *
    * @return the URL to the SCM server of the given {@link #getScmType() type}.
    */
   public String getScmUrl()
   {
     return scmUrl;
   }
 
   /**
    * Checks if SCM information is provided.
    *
    * @return <code>true</code> if SCM info is provided, <code>false</code> if
    *         not.
    */
   public boolean isScmInfoProvided()
   {
     return scmType != null; // && scmUrl != null;
   }
 
   /**
    * Sets the SCM information to the Maven POM.
    *
    * @param connectionString the connection string of format
    *          <code>scm:SCM_TYPE:SCM_URL</code>.
    * @throws BlankArgumentException if {@code connectionString} is
    *           <code>null</code>.
    * @throws IllegalArgumentException if the {@code connectionString} does not
    *           meet the expected format <code>scm:SCM_TYPE:SCM_URL</code>.
    */
   public void setScmConnectionString(final String connectionString)
     throws BlankArgumentException, IllegalArgumentException
   {
     Arguments.checkNotBlank("connectionString", connectionString);
     if (!connectionString.startsWith("scm:"))
     {
       throw new IllegalArgumentException(
           "SCM connection string does not start with 'scm:': "
               + connectionString);
     }
     final int endOfScmTypeString = connectionString.indexOf(':', 4);
     if (endOfScmTypeString == -1)
     {
       throw new IllegalArgumentException(
           "Cannot find SCM type"
               + " (expected between first and second ':') in connection string: "
               + connectionString);
     }
     final String scmTypeString =
         connectionString.substring(4, endOfScmTypeString);
     if ("http".equals(scmTypeString) || "https".equals(scmTypeString))
     {
       throw new IllegalArgumentException(
           "Cannot find valid SCM type"
               + " (expected between first and second ':') in connection string: "
               + connectionString);
     }
     final int startOfScmUrl = endOfScmTypeString + 1;
     if (connectionString.length() <= startOfScmUrl)
     {
       throw new IllegalArgumentException(
           "SCM connection string does not provide an URL: " + connectionString);
     }
 
     scmType = ScmType.getValueFor(scmTypeString);
     scmUrl = connectionString.substring(endOfScmTypeString + 1);
   }
 
   // --- business -------------------------------------------------------------
 
   // --- object basics --------------------------------------------------------
 
 }