From a40ff504cffe4e68d5a58a4c3f13e66ef807f91d Mon Sep 17 00:00:00 2001 From: Jesse Glick Date: Thu, 23 Jan 2014 17:21:17 -0800 Subject: [PATCH] Javadoc refinements for Describable. --- .../main/java/hudson/model/AbstractDescribableImpl.java | 7 +++++++ core/src/main/java/hudson/model/Describable.java | 5 +++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/core/src/main/java/hudson/model/AbstractDescribableImpl.java b/core/src/main/java/hudson/model/AbstractDescribableImpl.java index 50df6771ba..b3482c4430 100644 --- a/core/src/main/java/hudson/model/AbstractDescribableImpl.java +++ b/core/src/main/java/hudson/model/AbstractDescribableImpl.java @@ -23,6 +23,7 @@ */ package hudson.model; +import hudson.Extension; import jenkins.model.Jenkins; /** @@ -31,7 +32,13 @@ import jenkins.model.Jenkins; * @author Kohsuke Kawaguchi */ public abstract class AbstractDescribableImpl> implements Describable { + + /** + * By default looks for a nested class (conventionally named {@code DescriptorImpl}) implementing {@link Descriptor} and marked with {@link Extension}. + *

{@inheritDoc} + */ public Descriptor getDescriptor() { return Jenkins.getInstance().getDescriptorOrDie(getClass()); } + } diff --git a/core/src/main/java/hudson/model/Describable.java b/core/src/main/java/hudson/model/Describable.java index d916ed3488..ae8103b3cf 100644 --- a/core/src/main/java/hudson/model/Describable.java +++ b/core/src/main/java/hudson/model/Describable.java @@ -34,8 +34,9 @@ public interface Describable> { * *

* {@link Descriptor} is a singleton for every concrete {@link Describable} - * implementation, so if a.getClass()==b.getClass() then - * a.getDescriptor()==b.getDescriptor() must hold. + * implementation, so if {@code a.getClass() == b.getClass()} then by default + * {@code a.getDescriptor() == b.getDescriptor()} as well. + * (In rare cases a single implementation class may be used for instances with distinct descriptors.) */ Descriptor getDescriptor(); }