BuildMetadataContributor.java

/*
 *  The MIT License
 *
 *  Copyright 2011 Sony Ericsson Mobile Communications. All rights reserved.
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy
 *  of this software and associated documentation files (the "Software"), to deal
 *  in the Software without restriction, including without limitation the rights
 *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *  copies of the Software, and to permit persons to whom the Software is
 *  furnished to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in
 *  all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 *  THE SOFTWARE.
 */
package com.sonyericsson.hudson.plugins.metadata.contributors;

import com.sonyericsson.hudson.plugins.metadata.model.values.MetadataValue;
import hudson.ExtensionList;
import hudson.ExtensionPoint;
import hudson.model.AbstractBuild;
import hudson.model.Hudson;

import java.util.List;

/**
 * Extension point for plugins to contribute meta data to builds. When a build is done all contributors will be asked to
 * contribute meta data for that build.
 *
 * @author Robert Sandell <robert.sandell@sonyericsson.com>
 */
public abstract class BuildMetadataContributor implements ExtensionPoint {

    /**
     * Provides the meta-data that should be inserted into the build.
     *
     * @param build the build.
     * @return a list of meta data.
     */
    public abstract List<MetadataValue> getMetaDataFor(AbstractBuild build);

    /**
     * All the registered build-contributors.
     *
     * @return the list.
     */
    public static ExtensionList<BuildMetadataContributor> all() {
        return Hudson.getInstance().getExtensionList(BuildMetadataContributor.class);
    }
}