org.eclipse.jgit.submodule.SubmoduleStatus.java Source code

Introduction

Here is the source code for org.eclipse.jgit.submodule.SubmoduleStatus.java

Source

/*
 * Copyright (C) 2011, GitHub Inc.
 * and other copyright owners as documented in the project's IP log.
 *
 * This program and the accompanying materials are made available
 * under the terms of the Eclipse Distribution License v1.0 which
 * accompanies this distribution, is reproduced below, and is
 * available at http://www.eclipse.org/org/documents/edl-v10.php
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above
 *   copyright notice, this list of conditions and the following
 *   disclaimer in the documentation and/or other materials provided
 *   with the distribution.
 *
 * - Neither the name of the Eclipse Foundation, Inc. nor the
 *   names of its contributors may be used to endorse or promote
 *   products derived from this software without specific prior
 *   written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.eclipse.jgit.submodule;

import org.eclipse.jgit.lib.ObjectId;

/**
 * Status class containing the type, path, and commit id of the submodule.
 */
public class SubmoduleStatus {

    private final SubmoduleStatusType type;

    private final String path;

    private final ObjectId indexId;

    private final ObjectId headId;

    /**
     * Create submodule status
     *
     * @param type
     *            a {@link org.eclipse.jgit.submodule.SubmoduleStatusType}
     *            object.
     * @param path
     *            submodule path
     * @param indexId
     *            an {@link org.eclipse.jgit.lib.ObjectId} object.
     */
    public SubmoduleStatus(final SubmoduleStatusType type, final String path, final ObjectId indexId) {
        this(type, path, indexId, null);
    }

    /**
     * Create submodule status
     *
     * @param type
     *            a {@link org.eclipse.jgit.submodule.SubmoduleStatusType}
     *            object.
     * @param path
     *            submodule path
     * @param indexId
     *            index id
     * @param headId
     *            head id
     */
    public SubmoduleStatus(final SubmoduleStatusType type, final String path, final ObjectId indexId,
            final ObjectId headId) {
        this.type = type;
        this.path = path;
        this.indexId = indexId;
        this.headId = headId;
    }

    /**
     * Get type
     *
     * @return type
     */
    public SubmoduleStatusType getType() {
        return type;
    }

    /**
     * Get submodule path
     *
     * @return path submodule path
     */
    public String getPath() {
        return path;
    }

    /**
     * Get index object id
     *
     * @return index object id
     */
    public ObjectId getIndexId() {
        return indexId;
    }

    /**
     * Get HEAD object id
     *
     * @return HEAD object id
     */
    public ObjectId getHeadId() {
        return headId;
    }
}