io.knowledgelinks.cicd.semantic.versioning.git.GitTagReaderFactory Maven / Gradle / Ivy

package io.knowledgelinks.cicd.semantic.versioning.git;

/*-
 * #%L
 * Semantic Versioning
 * %%
 * Copyright (C) 2022 - 2023 Knowledgelinks
 * %%
 * 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.
 * #L%
 */

import io.knowledgelinks.cicd.semantic.versioning.config.Configuration;
import io.knowledgelinks.cicd.semantic.versioning.exceptions.SemanticVersioningException;
import io.knowledgelinks.cicd.semantic.versioning.parsers.VersionParser;

/**
 * Factory class the returns the GitTagReader instance based upon the configuration and runtime
 * values.
 * 
 * @author mstabile75
 *
 */
public class GitTagReaderFactory {

  private Configuration config;

  private VersionParser versionParser;

  private String repositoryUrl;

  public GitTagReaderFactory(Configuration config, VersionParser versionParser,
      String repositoryUrl) {
    this.config = config;
    this.versionParser = versionParser;
    this.repositoryUrl = repositoryUrl;

  }

  /**
   * Returns the instantiated GitTagReader class.
   * 
   * @return                             The reader to use for reading Git tags
   * @throws SemanticVersioningException Thrown when unable to generate the GitTagReader
   */
  public GitTagReader get() throws SemanticVersioningException {
    if (repositoryUrl != null) {
      return new GitLsRemoteTagReader(config, versionParser, repositoryUrl);
    }
    return new GitCommandLineTagReader(config, versionParser);
  }


}