FileStatusInfo (NetBeans VCS API) - NetBeans API Javadoc 4.1.0

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.api.vcs
Class FileStatusInfo

java.lang.Object
  org.netbeans.api.vcs.FileStatusInfo

public abstract class FileStatusInfo
extends Object

The file status information class.

Field Summary

static FileStatusInfo LOCAL
          The status of local files (files present in working directory, but not in the version control repository).

static FileStatusInfo MISSING
          The status of missing files (files present in the version control repository, but not in the working directory).

static FileStatusInfo MODIFIED
          The status of out-of-date files.

static FileStatusInfo OUT_OF_DATE
          The status of out-of-date files.

static FileStatusInfo UP_TO_DATE
          The status of up-to-date files.

Constructor Summary

FileStatusInfo(String status)
          Creates a new instance of FileStatusInfo

Method Summary

boolean equals(Object obj)
          Tell, whether this file status information is equal with another one.

abstract String getDisplayName()
          Get the localized string representation of this status info.

abstract Image getIcon()
          Get the icon for this status info.

String getName()
          Get the string representation of this FileStatusInfo.

boolean represents(FileStatusInfo info)
          Tell, whether this file status information represents just the same kind of status as another one.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOCAL

public static final FileStatusInfo LOCAL

The status of local files (files present in working directory, but not in the version control repository).

UP_TO_DATE

public static final FileStatusInfo UP_TO_DATE

The status of up-to-date files. The content of the file in working directory is exactly the same as the content of the recent revision in the version control repository.

OUT_OF_DATE

public static final FileStatusInfo OUT_OF_DATE

The status of out-of-date files. The content of the file in working directory is older, than the content of the recent revision in the version control repository.

MODIFIED

public static final FileStatusInfo MODIFIED

The status of out-of-date files. The content of the file in working directory is modified with respect to the corresponding revision in the version control repository.

MISSING

public static final FileStatusInfo MISSING

The status of missing files (files present in the version control repository, but not in the working directory).

Constructor Detail

FileStatusInfo

public FileStatusInfo(String status)

Creates a new instance of FileStatusInfo
Parameters:: status - The string representation of this status. This string should be different for different FileStatusInfo instances.

Method Detail

getName

public final String getName()

Get the string representation of this FileStatusInfo.

Returns:: The string status representation.

getDisplayName

public abstract String getDisplayName()

Get the localized string representation of this status info. Used for displaying purposes.

Returns:: The localized status representation.

getIcon

public abstract Image getIcon()

Get the icon for this status info.

Returns:: The icon representing this status info or null when there is no icon.

equals

public boolean equals(Object obj)

Tell, whether this file status information is equal with another one. They are equal when the string status representations are equal.

represents

public boolean represents(FileStatusInfo info)

Tell, whether this file status information represents just the same kind of status as another one. This method can be used by version control systems, that have more status information types, then the pre-defined constants. Use this to find out e.g. whether this status info represents one of the pre-defined status info.

Returns:: Whether this file status information represents just the same kind of status as another one. The default implementation just returns the result of equals(java.lang.Object).