io.knowledgelinks.cicd.semantic.versioning.formatters.VersionFormatter Maven / Gradle / Ivy

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

/*-
 * #%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.exceptions.SemanticVersioningException;
import io.knowledgelinks.cicd.semantic.versioning.versions.VersionInfo;

/**
 * A VersionFormatter will take a VersionInfo Object and convert it to a version string.
 * 
 * @author mstabile75
 *
 */
public interface VersionFormatter {

  /**
   * Converts the VersionInfo object into a version string.
   * 
   * @param  versionInfo                 The Version to format
   * @return                             The string representation of the versionInfo object
   * @throws SemanticVersioningException Thrown if the version cannot be converted
   */
  public String format(VersionInfo versionInfo) throws SemanticVersioningException;

}