ResetRequest.java

/*******************************************************************************
 * Copyright (c) 2012-2017 Codenvy, S.A.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Codenvy, S.A. - initial API and implementation
 *******************************************************************************/
package org.eclipse.che.api.git.shared;


import org.eclipse.che.dto.shared.DTO;

import java.util.List;

/**
 * Request to reset current HEAD to the specified state.
 *
 * @author andrew00x
 */
@DTO
public interface ResetRequest {
    /** Type of reset operation. */
    public enum ResetType {
        /** Change the ref and the index, the workdir is not changed (default). */
        MIXED("--mixed"),
        /** Just change the ref, the index and workdir are not changed. */
        SOFT("--soft"),
        /** Change the ref, the index and the workdir. */
        HARD("--hard"),
        /** Change the ref, the index and the workdir that are different between respective commit and HEAD. */
        KEEP("--keep"),
        /**
         * Resets the index and updates the files in the working tree that are different between respective commit and HEAD, but keeps
         * those
         * which are different between the index and working tree
         */
        MERGE("--merge");

        private final String value;

        private ResetType(String value) {
            this.value = value;
        }

        public String getValue() {
            return value;
        }
    }

    /** @return commit to which current head should be reset */
    String getCommit();
    
    void setCommit(String commit);
    
    ResetRequest withCommit(String commit);

    /** @return type of reset. */
    ResetType getType();
    
    void setType(ResetType type);

    /** @return files to reset the index */
    List<String> getFilePattern();

    void setFilePattern(List<String> filePattern);

    ResetRequest withFilePattern(List<String> filePattern);
}