ChangeRequestSCMHead2.java

/*
 * The MIT License
 *
 * Copyright (c) 2017 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.mixin;

import edu.umd.cs.findbugs.annotations.NonNull;
import jenkins.scm.api.SCMHead;
import jenkins.scm.api.SCMSource;

/**
 * Additional attributes of a {@link ChangeRequestSCMHead} that should have been in the original mixin but we are not
 * targeting Java 8 so we cannot add the default methods to the interface and must have an ugly {@code 2} class instead.
 * @since 2.2.0
 */
// TODO once Java 8 is baseline move method to ChangeRequestSCMHead with default return value,
// TODO deprecate this interface and add @Restricted(NoExternalUse.class) (retain empty interface for binary compat)
public interface ChangeRequestSCMHead2 extends ChangeRequestSCMHead {
    /**
     * Returns the {@link ChangeRequestCheckoutStrategy} of this {@link ChangeRequestSCMHead}.
     *
     * @return the {@link ChangeRequestCheckoutStrategy}.
     */
    @NonNull
    ChangeRequestCheckoutStrategy getCheckoutStrategy();

    /**
     * Returns the name of the actual head on the source control system which may or may not be different from
     * {@link #getName()}. For example in GitHub or Bitbucket this method would return the name of the origin branch
     * whereas {@link #getName()} would return something like {@code PR-24}. It is perfectly acceptable for a SCM
     * implementation to return the same value as {@link #getName()} where the SCM implementation does not have a
     * separate concept of origin name.
     *
     * @return the name this {@link ChangeRequestSCMHead} would have if the {@link SCMSource} were configured
     * against the {@link #getOrigin()} directly and the change request were be discoverable as a regular
     * {@link SCMHead} or {@link #getName()} if such a concept is not possible in the backing source control system.
     */
    @NonNull
    String getOriginName();
}