Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2006-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 com.redhat.rcm.maven.plugin.buildmetadata.common;
 
 import java.io.File;
 
Bundles the SCM information to be passed to meta data providers.

Author(s):
Robert Reiner
Version:
$Revision:591 $
 
 public final class ScmInfo
 {
   // ********************************* Fields *********************************
 
   // --- constants ------------------------------------------------------------
 
   // --- members --------------------------------------------------------------
 
  
The manager instance to access the SCM system. Provides access to the repository and the provider information.
 
   private final ScmManager scmManager;

  
Allows the user to choose which scm connection to use when connecting to the scm. Can either be "connection" or "developerConnection".
 
   private final String connectionType;

  
Used to specify the date format of the log entries that are retrieved from your SCM system.
 
   private final String scmDateFormat;

  
Input dir. Directory where the files under SCM control are located.
 
   private final File basedir;

  
The authentication for the SCM server.
 
   private final ScmCredentials scmCrendentials;

  
The url of tags base directory (used by svn protocol).
 
   private final String tagBase;

  
The range of the query in days to fetch change log entries from the SCM. If no change logs have been found, the range is incremented up to com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmAccessInfo.DEFAULT_RETRY_COUNT times. If no change log has been found after these com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmAccessInfo.DEFAULT_RETRY_COUNT additional queries, the revision number will not be set with a valid value.
 
   private final int queryRangeInDays;

  
The date pattern to use to format the build and revision dates. Please refer to the SimpleDateFormat class for valid patterns.
 
   private final String buildDatePattern;

  
The information to control the gathering of SCM meta data.
 
   private final ScmControl scmControl;
 
   // ****************************** Initializer *******************************
 
   // ****************************** Constructors ******************************
 
   // CHECKSTYLE:OFF
   
Default constructor.

Parameters:
scmManager the manager instance to access the SCM system.
connectionType the value for connectionType.
scmDateFormat the value for scmDateFormat.
basedir the value for basedir.
scmCrendentials the authentication for the SCM server.
tagBase the url of tags base directory (used by svn protocol).
queryRangeInDays the range of the query in days to fetch change log entries from the SCM.
buildDatePattern the date pattern to use to format the build and revision dates.
scmControl the information to control the gathering of SCM meta data.
Note:
This argument list is quite long. The next time we touch this class, we should provide a builder.
  public ScmInfo(final ScmManager scmManagerfinal String connectionType// NOPMD
      final String scmDateFormatfinal File basedir,
      final ScmCredentials scmCrendentialsfinal String tagBase,
      final int queryRangeInDaysfinal String buildDatePattern,
      final ScmControl scmControl)
  {
    this. = scmManager;
    this. = connectionType;
    this. = scmDateFormat;
    this. = basedir;
    this. = scmCrendentials;
    this. = tagBase;
    this. = queryRangeInDays;
    this. = buildDatePattern;
    this. = scmControl;
  }
  // CHECKSTYLE:ON
  // ****************************** Inner Classes *****************************
  // ********************************* Methods ********************************
  // --- init -----------------------------------------------------------------
  // --- get&set --------------------------------------------------------------

  
Returns the manager instance to access the SCM system. Provides access to the repository and the provider information.

Returns:
the manager instance to access the SCM system.
  {
    return ;
  }

  
Returns the value for connectionType.

Allows the user to choose which scm connection to use when connecting to the scm. Can either be "connection" or "developerConnection".

Returns:
the value for connectionType.
  {
    return ;
  }

  
Returns the value for scmDateFormat.

Used to specify the date format of the log entries that are retrieved from your SCM system.

Returns:
the value for scmDateFormat.
  {
    return ;
  }

  
Returns the value for basedir.

Input dir. Directory where the files under SCM control are located.

Returns:
the value for basedir.
  public File getBasedir()
  {
    return ;
  }

  
Returns the authentication for the SCM server.

Returns:
the authentication for the SCM server.
  {
    return ;
  }

  
Returns the url of tags base directory (used by svn protocol).

Returns:
the url of tags base directory (used by svn protocol).
  public String getTagBase()
  {
    return ;
  }

  
Returns the range of the query in days to fetch change log entries from the SCM. If no change logs have been found, the range is incremented up to com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmAccessInfo.DEFAULT_RETRY_COUNT times. If no change log has been found after these com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmAccessInfo.DEFAULT_RETRY_COUNT additional queries, the revision number will not be set with a valid value.

Returns:
the range of the query in days to fetch change log entries from the SCM.
  public int getQueryRangeInDays()
  {
    return ;
  }

  
Returns the date pattern to use to format the build and revision dates. Please refer to the SimpleDateFormat class for valid patterns.

Returns:
the date pattern to use to format the build and revision dates.
  {
    return ;
  }

  
Returns the information to control the gathering of SCM meta data.

Returns:
the information to control the gathering of SCM meta data.
  {
    return ;
  }
  // --- business -------------------------------------------------------------
  // --- object basics --------------------------------------------------------
New to GrepCode? Check out our FAQ X