VcsListCommand (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.modules.vcscore.cmdline
Class VcsListCommand

java.lang.Object
  org.netbeans.modules.vcscore.cmdline.VcsListCommand

public abstract class VcsListCommand
extends Object

An abstract list command, that every class has to implement to provide a listing information.

Constructor Summary

VcsListCommand()


Method Summary

protected String array2string(String[] sa)
          Makes a single String from the array of Strings.

abstract boolean list(Hashtable vars, String[] args, Hashtable filesByName, CommandOutputListener stdoutListener, CommandOutputListener stderrListener, CommandDataOutputListener stdoutDataListener, String dataRegex, CommandDataOutputListener stderrDataListener, String errorRegex)
          This method is called when the content of the directory is to be listed.

Methods inherited from class java.lang.Object

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

Constructor Detail

VcsListCommand

public VcsListCommand()

Method Detail

array2string

protected String array2string(String[] sa)

Makes a single String from the array of Strings.

list

public abstract boolean list(Hashtable vars,
                             String[] args,
                             Hashtable filesByName,
                             CommandOutputListener stdoutListener,
                             CommandOutputListener stderrListener,
                             CommandDataOutputListener stdoutDataListener,
                             String dataRegex,
                             CommandDataOutputListener stderrDataListener,
                             String errorRegex)

This method is called when the content of the directory is to be listed.

Parameters:: vars - the variables that can be passed to the command; args - the command line parametres passed to it in properties; filesByName - return the files read from the given directory, or the error description when an error occures. The keys in this Hashtable are supposed to be file names, values are supposed to be an array of String containing statuses.; stdoutListener - listener of the standard output of the command; stderrListener - listener of the error output of the command; stdoutDataListener - listener of the standard output of the command which satisfies regex dataRegex; dataRegex - the regular expression for parsing the standard output; stderrDataListener - listener of the error output of the command which satisfies regex errorRegex; errorRegex - the regular expression for parsing the error output
Returns:: true if the command was succesfull false if some error occured.