Examples of hudson.model.Descriptor

hudson.model.Descriptor
Metadata about a configurable instance.
{@link Descriptor} is an object that has metadata about a {@link Describable}object, and also serves as a factory (in a way this relationship is similar to {@link Object}/ {@link Class} relationship.A {@link Descriptor}/ {@link Describable}combination is used throughout in Hudson to implement a configuration/extensibility mechanism.
Take the list view support as an example, which is implemented in {@link ListView} class. Whenever a new view is created, a new{@link ListView} instance is created with the configurationinformation. This instance gets serialized to XML, and this instance will be called to render the view page. This is the job of {@link Describable} — each instance represents a specificconfiguration of a view (what projects are in it, regular expression, etc.)
For Hudson to create such configured {@link ListView} instance, Hudsonneeds another object that captures the metadata of {@link ListView}, and that is what a {@link Descriptor} is for. {@link ListView} classhas a singleton descriptor, and this descriptor helps render the configuration form, remember system-wide configuration, and works as a factory.
{@link Descriptor} also usually have its associated views.
Persistence

{@link Descriptor} can persist data just by storing them in fields.However, it is the responsibility of the derived type to properly invoke {@link #save()} and {@link #load()}.
Reflection Enhancement
{@link Descriptor} defines addition to the standard Java reflectionand provides reflective information about its corresponding {@link Describable}. These are primarily used by tag libraries to keep the Jelly scripts concise. @author Kohsuke Kawaguchi @see Describable

     * Determines the form validation check URL. See textbox.jelly
     */
    public String getCheckUrl(String userDefined, Object descriptor, String field) {
        if(userDefined!=null || field==null)   return userDefined;
        if (descriptor instanceof Descriptor) {
            Descriptor d = (Descriptor) descriptor;
            return d.getCheckUrl(field);
        }
        return null;
    }

View Full Code Here

     * Filters a descriptor for {@link BuildStep}s by using {@link BuildStepDescriptor#isApplicable(Class)}.
     */
    public static <T extends BuildStep&Describable<T>>
    List<Descriptor<T>> filter(List<Descriptor<T>> base, Class<? extends AbstractProject> type) {
        // descriptor of the project
        Descriptor pd = Hudson.getInstance().getDescriptor((Class) type);


        List<Descriptor<T>> r = new ArrayList<Descriptor<T>>(base.size());
        for (Descriptor<T> d : base) {
            if (pd instanceof AbstractProjectDescriptor && !((AbstractProjectDescriptor)pd).isApplicable(d))
                continue;

View Full Code Here

     */
    @Override
    protected List<ExtensionComponent<D>> load() {
        List<ExtensionComponent<D>> r = new ArrayList<ExtensionComponent<D>>();
        for( ExtensionComponent<Descriptor> c : hudson.getExtensionList(Descriptor.class).getComponents() ) {
            Descriptor d = c.getInstance();
            Type subTyping = Types.getBaseClass(d.getClass(), Descriptor.class);
            if (!(subTyping instanceof ParameterizedType)) {
                LOGGER.severe(d.getClass()+" doesn't extend Descriptor with a type parameter");
                continue;   // skip this one
            }
            if(Types.erasure(Types.getTypeArgument(subTyping,0))==(Class)describableType)
                r.add((ExtensionComponent)c);
        }

View Full Code Here

0 1

TOP

Related Classes of hudson.model.Descriptor

com.sonyericsson.hudson.plugins.metadata.model.values.TreeNodeMetadataValue$TreeNodeMetaDataValueDescriptor

hudson.DescriptorExtensionList

hudson.tasks.BuildStepDescriptor

hudson.tasks.BuildWrappers

hudson.XmlFile

jenkins.model.Jenkins

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.

Examples of hudson.model.Descriptor

Persistence

Reflection Enhancement

Related Classes of hudson.model.Descriptor