ObjectMetadataAction.java

/*
 * The MIT License
 *
 * Copyright (c) 2016 CloudBees, Inc.
 *
 * 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 jenkins.scm.api.metadata;

import edu.umd.cs.findbugs.annotations.CheckForNull;
import hudson.Util;
import hudson.model.InvisibleAction;
import java.io.Serializable;
import java.util.Objects;

import jenkins.model.Jenkins;
import jenkins.scm.api.SCMHead;
import jenkins.scm.api.SCMNavigator;
import jenkins.scm.api.SCMRevision;
import jenkins.scm.api.SCMSource;
import org.kohsuke.stapler.export.Exported;
import org.kohsuke.stapler.export.ExportedBean;

/**
 * Holds metadata about the object referenced by a {@link SCMRevision}, {@link SCMHead}, {@link SCMSource} or
 * {@link SCMNavigator}.
 * <p>
 * For example:
 * <ul>
 *     <li>A {@link SCMNavigator} implementation that corresponds to a GitHub Team could use the
 *     {@link #getObjectUrl()} to point to the GitHub Team page, and the {@link #getObjectDisplayName()} to provide the
 *     team name</li>
 *     <li>A {@link SCMSource} implementation that corresponds to a GitHub Repository could use the
 *     {@link #getObjectUrl()} to point to the GitHub repository, and the {@link #getObjectDescription()} to provide the
 *     repository description name</li>
 *     <li>A {@link SCMHead} implementation that corresponds to a GitHub Pull Request could use the
 *     {@link #getObjectUrl()} to point to the pull request on GitHub, the {@link #getObjectDisplayName()} to provide
 *     the title of the pull request and {@link #getObjectDescription()} to provide the description of the pull request
 *     </li>
 *     <li>An external {@link SCMSource} implementation that corresponds to a Gitea repository could use the
 *     {@link #getObjectUrl()} to point to the Gitea repository URL, the {@link #getObjectDisplayName()} to provide
 *     the repository name, the {@link #getObjectDescription()} to provide the description of repository, and the
 *     the optional {@link #getHtmlObjectDescription()} to provide the displayed repository description.
 *     </li>
 * </ul>
 *
 * @since 2.0
 */
@ExportedBean
public class ObjectMetadataAction extends InvisibleAction implements Serializable {
    /**
     * Ensure consistent serialization.
     */
    private static final long serialVersionUID = 1L;

    @CheckForNull
    private final String objectDisplayName;
    @CheckForNull
    private final String objectDescription;
    @CheckForNull
    private final String objectUrl;
    @CheckForNull
    private final String htmlObjectDescription;

    public ObjectMetadataAction(@CheckForNull String objectDisplayName,
                                @CheckForNull String objectDescription,
                                @CheckForNull String objectUrl) {
        // [JENKINS-75069] Default htmlObjectDescription set to null in order to keep the initial constructor
        // to prevent an interface disruption
        this(objectDisplayName, objectDescription, objectUrl, null);
    }

    public ObjectMetadataAction(@CheckForNull String objectDisplayName,
                                @CheckForNull String objectDescription,
                                @CheckForNull String objectUrl,
                                @CheckForNull String htmlObjectDescription) {
        this.objectDisplayName = objectDisplayName;
        this.objectDescription = objectDescription;
        this.objectUrl = objectUrl;
        this.htmlObjectDescription = htmlObjectDescription;
    }

    /**
     * Returns the display name of the object or {@code null}. Consumers should assume the content is plain text that
     * needs escaping with {@link Util#escape(String)} when being included in HTML output.
     *
     * @return the display name of the object or {@code null}
     */
    @Exported
    @CheckForNull
    // note we need to call this getObjectDisplayName() to avoid conflicting with InvisibleAction.getDisplayName()
    public String getObjectDisplayName() {
        return objectDisplayName;
    }

    /**
     * Returns the description of the object or {@code null}. Consumers should assume the content is plain text that
     * needs escaping with {@link Util#escape(String)} when being included in HTML output.
     *
     * @return the description of the object or {@code null}.
     */
    @Exported
    @CheckForNull
    public String getObjectDescription() {
        return objectDescription;
    }

    /**
     * Returns the external url of the object or {@code null} if the object does not have an external url.
     *
     * @return the display name of the object or {@code null}
     */
    @Exported
    @CheckForNull
    // note we need to call this getObjectDisplayName() to avoid conflicting with InvisibleAction.getUrl()
    public String getObjectUrl() {
        return objectUrl;
    }

    /**
     * Returns the description of the object or {@code null} for the HTML content. Consumers should assume the content
     * is valid HTML or plain text that needs to be formatted with {@link Jenkins#getMarkupFormatter()}
     * or escaped with {@link Util#escape(String)} when being included in HTML output.
     * Note: If this value is {@code null}, Consumers should get the default object description with
     * {@link #getObjectDescription()}.
     *
     * @return the description of the object for the HTML content or {@code null}.
     */
    @Exported
    @CheckForNull
    public String getHtmlObjectDescription() {
        return this.htmlObjectDescription;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        ObjectMetadataAction that = (ObjectMetadataAction) o;

        if (!Objects.equals(objectDisplayName, that.objectDisplayName)) {
            return false;
        }
        if (!Objects.equals(objectDescription, that.objectDescription)) {
            return false;
        }
        if (!Objects.equals(htmlObjectDescription, that.htmlObjectDescription)) {
            return false;
        }
        return Objects.equals(objectUrl, that.objectUrl);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int hashCode() {
        int result = objectDisplayName != null ? objectDisplayName.hashCode() : 0;
        result = 31 * result + (objectDescription != null ? objectDescription.hashCode() : 0);
        result = 31 * result + (objectUrl != null ? objectUrl.hashCode() : 0);
        result = 31 * result + (htmlObjectDescription != null ? htmlObjectDescription.hashCode() : 0);
        return result;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString() {
        return "ObjectMetadataAction{" +
                "objectDisplayName='" + objectDisplayName + '\'' +
                ", objectDescription='" + objectDescription + '\'' +
                ", objectUrl='" + objectUrl + '\'' +
                ", htmlObjectDescription='" + htmlObjectDescription + '\'' +
                '}';
    }
}