spring BuildpackCoordinates 源码

springboot BuildpackCoordinates 代码

文件路径：/spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/build/BuildpackCoordinates.java

/*
 * Copyright 2012-2021 the original author or authors.
 *
 * 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
 *
 *      https://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 org.springframework.boot.buildpack.platform.build;

import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Path;

import org.tomlj.Toml;
import org.tomlj.TomlParseResult;

import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;
import org.springframework.util.StringUtils;

/**
 * A set of buildpack coordinates that uniquely identifies a buildpack.
 *
 * @author Scott Frederick
 * @see <a href=
 * "https://github.com/buildpacks/spec/blob/main/platform.md#ordertoml-toml">Platform
 * Interface Specification</a>
 */
final class BuildpackCoordinates {

	private final String id;

	private final String version;

	private BuildpackCoordinates(String id, String version) {
		Assert.hasText(id, "ID must not be empty");
		this.id = id;
		this.version = version;
	}

	String getId() {
		return this.id;
	}

	/**
	 * Return the buildpack ID with all "/" replaced by "_".
	 * @return the ID
	 */
	String getSanitizedId() {
		return this.id.replace("/", "_");
	}

	String getVersion() {
		return this.version;
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj) {
			return true;
		}
		if (obj == null || getClass() != obj.getClass()) {
			return false;
		}
		BuildpackCoordinates other = (BuildpackCoordinates) obj;
		return this.id.equals(other.id) && ObjectUtils.nullSafeEquals(this.version, other.version);
	}

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + this.id.hashCode();
		result = prime * result + ObjectUtils.nullSafeHashCode(this.version);
		return result;
	}

	@Override
	public String toString() {
		return this.id + ((StringUtils.hasText(this.version)) ? "@" + this.version : "");
	}

	/**
	 * Create {@link BuildpackCoordinates} from a <a href=
	 * "https://github.com/buildpacks/spec/blob/main/buildpack.md#buildpacktoml-toml">{@code buildpack.toml}</a>
	 * file.
	 * @param inputStream an input stream containing {@code buildpack.toml} content
	 * @param path the path to the buildpack containing the {@code buildpack.toml} file
	 * @return a new {@link BuildpackCoordinates} instance
	 * @throws IOException on IO error
	 */
	static BuildpackCoordinates fromToml(InputStream inputStream, Path path) throws IOException {
		return fromToml(Toml.parse(inputStream), path);
	}

	private static BuildpackCoordinates fromToml(TomlParseResult toml, Path path) {
		Assert.isTrue(!toml.isEmpty(),
				() -> "Buildpack descriptor 'buildpack.toml' is required in buildpack '" + path + "'");
		Assert.hasText(toml.getString("buildpack.id"),
				() -> "Buildpack descriptor must contain ID in buildpack '" + path + "'");
		Assert.hasText(toml.getString("buildpack.version"),
				() -> "Buildpack descriptor must contain version in buildpack '" + path + "'");
		Assert.isTrue(toml.contains("stacks") || toml.contains("order"),
				() -> "Buildpack descriptor must contain either 'stacks' or 'order' in buildpack '" + path + "'");
		Assert.isTrue(!(toml.contains("stacks") && toml.contains("order")),
				() -> "Buildpack descriptor must not contain both 'stacks' and 'order' in buildpack '" + path + "'");
		return new BuildpackCoordinates(toml.getString("buildpack.id"), toml.getString("buildpack.version"));
	}

	/**
	 * Create {@link BuildpackCoordinates} by extracting values from
	 * {@link BuildpackMetadata}.
	 * @param buildpackMetadata the buildpack metadata
	 * @return a new {@link BuildpackCoordinates} instance
	 */
	static BuildpackCoordinates fromBuildpackMetadata(BuildpackMetadata buildpackMetadata) {
		Assert.notNull(buildpackMetadata, "BuildpackMetadata must not be null");
		return new BuildpackCoordinates(buildpackMetadata.getId(), buildpackMetadata.getVersion());
	}

	/**
	 * Create {@link BuildpackCoordinates} from an ID and version.
	 * @param id the buildpack ID
	 * @param version the buildpack version
	 * @return a new {@link BuildpackCoordinates} instance
	 */
	static BuildpackCoordinates of(String id, String version) {
		return new BuildpackCoordinates(id, version);
	}

}

相关信息

spring 源码目录

相关文章

spring AbstractBuildLog 源码

spring ApiVersion 源码

spring ApiVersions 源码

spring BuildLog 源码

spring BuildOwner 源码

spring BuildRequest 源码

spring Builder 源码

spring BuilderBuildpack 源码

spring BuilderException 源码

spring BuilderMetadata 源码