Interface Named

All Known Subinterfaces:

AdhocComponentWithVariants, AggregateTestReport, AntlrSourceDirectorySet, ApplicationBinarySpec, ApplicationSpec, Architecture, ArtifactTypeDefinition, AssemblerSourceSet, Authentication, AwsImAuthentication, BasicAuthentication, BinaryContainer, BinarySpec, BuildableComponent, BuildableComponentSpec, BuildServiceRegistration<T,P>, BuildType, Bundling, Category, CheckableComponentSpec, Clang, ComponentSpec, ComponentSpecContainer, ComponentWithBinaries, ComponentWithCoordinates, ComponentWithDependencies, ComponentWithExecutable, ComponentWithInstallation, ComponentWithLinkFile, ComponentWithLinkUsage, ComponentWithNativeRuntime, ComponentWithObjectFiles, ComponentWithOutputs, ComponentWithRuntimeFile, ComponentWithRuntimeUsage, ComponentWithSharedLibrary, ComponentWithStaticLibrary, ComponentWithVariants, Configuration, ConfigurationVariant, ConsumableConfiguration, CppApplication, CppBinary, CppComponent, CppExecutable, CppLibrary, CppSharedLibrary, CppSourceSet, CppStaticLibrary, CppTestExecutable, CppTestSuite, CSourceSet, CUnitTestSuiteBinarySpec, CUnitTestSuiteSpec, DependencyScopeConfiguration, DependentSourceSet, DependentSourceSet, DigestAuthentication, Distribution, DocsType, Flavor, FunctionalSourceSet, Gcc, GccCompatibleToolChain, GeneralComponentSpec, GoogleTestTestSuiteBinarySpec, GoogleTestTestSuiteSpec, GradlePluginApiVersion, GroovySourceDirectorySet, HeaderExportingSourceSet, HttpHeaderAuthentication, IvyConfiguration, IvyPublication, JacocoCoverageReport, JvmTestSuite, JvmTestSuiteTarget, LanguageSourceSet, LegacyConfiguration, LibraryBinarySpec, LibraryElements, LibrarySpec, MavenPublication, ModelElement, ModelMap<T>, ModelSet<T>, NativeBinarySpec, NativeComponentSpec, NativeExecutableBinarySpec, NativeExecutableSpec, NativeLibraryBinarySpec, NativeLibrarySpec, NativePlatform, NativeResourceSet, NativeTestSuiteBinarySpec, NativeTestSuiteSpec, NativeToolChain, ObjectFilesToBinary, ObjectiveCppSourceSet, ObjectiveCSourceSet, OperatingSystem, Platform, PlatformAwareComponentSpec, PrebuiltLibrary, Product, ProductionComponent, ProductionCppComponent, ProductionSwiftComponent, Publication, PublishableComponent, ReportSpec, ResolvableConfiguration, ScalaSourceDirectorySet, SharedLibraryBinarySpec, SoftwareComponent, SoftwareComponentVariant, SourceComponentSpec, SourceDirectorySet, StaticLibraryBinarySpec, SwiftApplication, SwiftBinary, Swiftc, SwiftComponent, SwiftExecutable, SwiftLibrary, SwiftSharedLibrary, SwiftStaticLibrary, SwiftXCTestBinary, SwiftXCTestBundle, SwiftXCTestExecutable, SwiftXCTestSuite, TargetedNativeComponent, TargetJvmEnvironment, Task, TaskReference, TestComponent, TestSuite, TestSuiteBinarySpec, TestSuiteComponent, TestSuiteContainer, TestSuiteName, TestSuiteSpec, ToolChain, Usage, VariantComponent, VariantComponentSpec, VerificationType, VersionCatalog, VersionCatalogBuilder, VisualCpp, VisualStudioProject, VisualStudioSolution, WindowsResourceSet

All Known Implementing Classes:

AbstractArchiveTask, org.gradle.api.internal.AbstractBuildableComponentSpec, AbstractCodeQualityTask, AbstractCompile, org.gradle.platform.base.component.internal.AbstractComponentSpec, AbstractConfigurationReportTask, AbstractCopyTask, AbstractDependencyReportTask, AbstractExecTask, org.gradle.language.base.internal.AbstractLanguageSourceSet, AbstractLinkTask, AbstractNativeCompileTask, AbstractNativePCHCompileTask, AbstractNativeSourceCompileTask, AbstractProjectBasedReportTask, AbstractPublishToMaven, AbstractReportTask, AbstractScalaCompile, org.gradle.api.internal.AbstractTask, AbstractTestTask, AntlrTask, AntTarget, ArtifactTransformsReportTask, Assemble, Attribute, BaseBinarySpec, BaseComponentSpec, BaseLanguageSourceSet, BuildEnvironmentReportTask, CCompile, Checkstyle, CodeNarc, ComponentReport, ConventionReportTask, org.gradle.api.internal.ConventionTask, Copy, CppCompile, CppPreCompiledHeaderCompile, CPreCompiledHeaderCompile, CreateStartScripts, CreateStartScripts, CreateStaticLibrary, org.gradle.platform.base.component.internal.DefaultComponentSpec, DefaultTask, Delete, DependencyInsightReportTask, DependencyReportTask, DependentComponentsReport, Ear, Exec, ExtractSymbols, GenerateBuildDashboard, GenerateCUnitLauncher, GenerateEclipseClasspath, GenerateEclipseJdt, GenerateEclipseProject, GenerateEclipseWtpComponent, GenerateEclipseWtpFacet, GenerateFiltersFileTask, GenerateIdeaModule, GenerateIdeaProject, GenerateIdeaWorkspace, GenerateIvyDescriptor, GenerateMavenPom, GenerateModuleMetadata, GeneratePluginDescriptors, GenerateProjectFileTask, GenerateSchemeFileTask, GenerateSolutionFileTask, GenerateSwiftPackageManagerManifest, GenerateWorkspaceSettingsFileTask, GenerateXcodeProjectFileTask, GenerateXcodeWorkspaceFileTask, GeneratorTask, GradleBuild, GroovyCompile, Groovydoc, HtmlDependencyReportTask, InitBuild, InstallExecutable, InstallXCTestBundle, JacocoBase, JacocoCoverageVerification, JacocoReport, JacocoReportBase, Jar, Jar, JavaCompile, Javadoc, JavaExec, Linkage, LinkExecutable, LinkMachOBundle, LinkSharedLibrary, MachineArchitecture, ModelReport, ObjectiveCCompile, ObjectiveCppCompile, ObjectiveCppPreCompiledHeaderCompile, ObjectiveCPreCompiledHeaderCompile, OperatingSystemFamily, OutgoingVariantsReportTask, PluginDeclaration, PluginUnderTestMetadata, Pmd, PrefixHeaderFileGenerateTask, ProcessResources, ProjectBasedReportTask, ProjectReportTask, PropertiesGeneratorTask, PropertyListGeneratorTask, PropertyReportTask, PublishToIvyRepository, PublishToMavenLocal, PublishToMavenRepository, ResolvableConfigurationsReportTask, RunTestExecutable, ScalaCompile, ScalaDoc, Sign, SourceTask, StripSymbols, SwiftCompile, Sync, Tar, TaskReportTask, Test, TestReport, UnexportMainSymbol, UpdateDaemonJvm, ValidatePlugins, War, WindowsResourceCompile, Wrapper, WriteProperties, XCTest, XmlGeneratorTask, Zip

public interface Named

Types can implement this interface and use the embedded Named.Namer implementation, to satisfy API that calls for a namer.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Named.Namer	An implementation of the namer interface for objects implementing the named interface.

Method Summary

Modifier and Type	Method	Description
String	getName()	The object's name.

Method Details

getName

String getName()

The object's name.

Must be constant for the life of the object.

Implementations should not declare a Object.toString() that returns anything other than this name. Gradle derives the name from this method wherever it needs one, but renders the object with toString() in diagnostics, so the two disagreeing produces output that contradicts the behavior it describes. This is easy to miss on an enum, which inherits a toString() returning Enum.name().

Returns:

The name. Never null.

Since:

1.0