org.spearce.egit.ui/src/org/spearce/egit/ui/internal/decorators/IDecoratableResource.java

   1 /*******************************************************************************
   2  * Copyright (C) 2008, Tor Arne Vestbø <torarnv@gmail.com>
   3  *
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * See LICENSE for the full license text, also available.
   7  *******************************************************************************/
   8
   9 package org.spearce.egit.ui.internal.decorators;
  10
  11 import org.eclipse.core.resources.IResource;
  12
  13 /**
  14  * Represents the state of a resource that can be used as a basis for decoration
  15  */
  16 public interface IDecoratableResource {
  17
  18         /**
  19          * Set of possible staging states for a resource
  20          */
  21         public enum Staged {
  22                 /** Represents a resource that is not staged */
  23                 NOT_STAGED,
  24                 /** Represents a resource that has been modified */
  25                 MODIFIED,
  26                 /** Represents a resource that is added to Git */
  27                 ADDED,
  28                 /** Represents a resource that is removed from Git */
  29                 REMOVED,
  30                 /** Represents a resource that has been renamed */
  31                 RENAMED
  32         }
  33
  34         /**
  35          * Gets the type of the resource as defined by {@link IResource}
  36          *
  37          * @return the type of the resource
  38          */
  39         int getType();
  40
  41         /**
  42          * Gets the name of the resource
  43          *
  44          * @return the name of the resource
  45          */
  46         String getName();
  47
  48         /**
  49          * Gets the current branch of the resource if applicable
  50          *
  51          * @return the name of the current branch, or <code>null</code> if not
  52          *         applicable
  53          */
  54         String getBranch();
  55
  56         /**
  57          * Returns whether or not the resource is tracked by Git
  58          *
  59          * @return whether or not the resource is tracked by Git
  60          */
  61         boolean isTracked();
  62
  63         /**
  64          * Returns whether or not the resource is ignored, either by a global team
  65          * ignore in Eclipse, or by .git/info/exclude et al.
  66          *
  67          * @return whether or not the resource is ignored
  68          */
  69         boolean isIgnored();
  70
  71         /**
  72          * Returns whether or not the resource has changes that are not staged
  73          *
  74          * @return whether or not the resource is dirty
  75          */
  76         boolean isDirty();
  77
  78         /**
  79          * Returns the staged state of the resource
  80          *
  81          * The set of allowed values are defined by the <code>Staged</code> enum
  82          *
  83          * @return the staged state of the resource
  84          */
  85         Staged staged();
  86
  87         /**
  88          * Returns whether or not the resource has merge conflicts
  89          *
  90          * @return whether or not the resource has merge conflicts
  91          */
  92         boolean hasConflicts();
  93
  94         /**
  95          * Returns whether or not the resource is assumed valid
  96          *
  97          * @return whether or not the resource is assumed valid
  98          */
  99         boolean isAssumeValid();
 100 }