org.gradle.configuration.ConfigurationTargetIdentifier Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
/*
* Copyright 2017 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
*
* 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 org.gradle.configuration;
import org.gradle.api.internal.GradleInternal;
import org.gradle.api.internal.SettingsInternal;
import org.gradle.api.internal.plugins.PluginAwareInternal;
import org.gradle.api.internal.project.ProjectInternal;
import org.gradle.util.internal.TextUtil;
import javax.annotation.Nullable;
/**
* Uniquely identifies the target of some configuration.
*
* This is primarily used to support
* {@code ApplyScriptPluginBuildOperationType.Details} and {@code ApplyPluginBuildOperationType.Details}.
*/
public abstract class ConfigurationTargetIdentifier {
private ConfigurationTargetIdentifier() {
}
public enum Type {
GRADLE,
SETTINGS,
PROJECT;
public final String label = TextUtil.toLowerCaseLocaleSafe(name());
}
public abstract Type getTargetType();
/**
* If type == project, that project's path (not identity path).
* Else, null.
*/
@Nullable
public abstract String getTargetPath();
public abstract String getBuildPath();
/**
* Returns null if the thing is of an unknown type.
* This can happen with {@code apply(from: "foo", to: someTask)},
* where “to” can be absolutely anything.
*/
@Nullable
public static ConfigurationTargetIdentifier of(Object any) {
if (any instanceof PluginAwareInternal) {
return ((PluginAwareInternal) any).getConfigurationTargetIdentifier();
} else {
return null;
}
}
public static ConfigurationTargetIdentifier of(final ProjectInternal project) {
return new ConfigurationTargetIdentifier() {
@Override
public Type getTargetType() {
return Type.PROJECT;
}
@Nullable
@Override
public String getTargetPath() {
return project.getProjectPath().getPath();
}
@Override
public String getBuildPath() {
return project.getGradle().getIdentityPath().getPath();
}
};
}
public static ConfigurationTargetIdentifier of(final SettingsInternal settings) {
return new ConfigurationTargetIdentifier() {
@Override
public Type getTargetType() {
return Type.SETTINGS;
}
@Nullable
@Override
public String getTargetPath() {
return null;
}
@Override
public String getBuildPath() {
return settings.getGradle().getIdentityPath().getPath();
}
};
}
public static ConfigurationTargetIdentifier of(final GradleInternal gradle) {
return new ConfigurationTargetIdentifier() {
@Override
public Type getTargetType() {
return Type.GRADLE;
}
@Nullable
@Override
public String getTargetPath() {
return null;
}
@Override
public String getBuildPath() {
return gradle.getIdentityPath().getPath();
}
};
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy