|
RSE Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.rse.subsystems.shells.core.model.RemoteCommandFilterString
public class RemoteCommandFilterString
A string representing a filter sent to remote file subsystems.
Filters can be absolute or relative. Absolute contains a folder path, while relative do not.
The files can be filtered by name, or by a list of file types. If by name, it can have up to 2 asterisks anywhere in the name for wildcarding. If by types, multiple types can by specified. The types are the file extensions without the dot, as in "java" or "class".
Examples:
d:\mystuff\phil*.abc
phil*.abc
d:\mystuff\java,class,
java,class,
Syntactically, file type filter strings have at least one comma. Note that the file name filter string "*.java" is semantically the same as a type filter string "java,". Either one can be used and will get the same results. However, if you specify "java" you will be in trouble, as it will mean look for a file explicitly named "java".
It is invalid to have both a comma and an asterisk in the same filter string. It is also invalid to have both a comma and a period in the same filter string.
Clients may use or subclass this class. When subclassing, clients need to
ensure that the subclass is always capable of performing a deep clone
operation with the clone()
method, so if they add fields of
complex type, these need to be dealt with by overriding clone()
.
Field Summary | |
---|---|
protected boolean |
filterByTypes
|
protected String |
shellStr
|
protected String[] |
types
|
Constructor Summary | |
---|---|
RemoteCommandFilterString()
Constructor to use for a filter to list roots when used absolutely, or list all contents when used relatively. |
|
RemoteCommandFilterString(IRemoteCmdSubSystemConfiguration subsysFactory)
Constructor to use when there is no existing filter string. |
|
RemoteCommandFilterString(IRemoteCmdSubSystemConfiguration subsysFactory,
String input)
Constructor to use when an absolute filter string already exists. |
|
RemoteCommandFilterString(IRemoteCmdSubSystemConfiguration subsysFactory,
String path,
String input)
Constructor to use when you have a path and filename filter or comma-separated file types list. |
Method Summary | |
---|---|
Object |
clone()
Clone this into another filter string object with the same attributes. |
boolean |
getFilterByTypes()
Return true if this filter string filters by file types versus by file name |
String[] |
getTypes()
Get the types to subset by, if specified. |
String |
getTypesAsString()
For file types filters, returns the types as a string of concatenated types, comma-delimited. |
static String |
getTypesString(String[] typesArray)
Concatenate the given file types as a single string, each type comma-separated |
void |
setSubSystemConfiguration(IRemoteCmdSubSystemConfiguration subsysFactory)
|
void |
setTypes(String[] types)
Set the file types to subset by. |
String |
toString()
Serialize into a string capturing all the attributes |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected String shellStr
protected String[] types
protected boolean filterByTypes
Constructor Detail |
---|
public RemoteCommandFilterString()
public RemoteCommandFilterString(IRemoteCmdSubSystemConfiguration subsysFactory)
This constructor is better that the default constructor, because it takes a remote file subsystem factory, from which we can query the folder and path separator characters, which are needed to parse and re-build filter strings.
setTypes(String[])
public RemoteCommandFilterString(IRemoteCmdSubSystemConfiguration subsysFactory, String input)
public RemoteCommandFilterString(IRemoteCmdSubSystemConfiguration subsysFactory, String path, String input)
Method Detail |
---|
public void setSubSystemConfiguration(IRemoteCmdSubSystemConfiguration subsysFactory)
public void setTypes(String[] types)
public static String getTypesString(String[] typesArray)
public String getTypesAsString()
public String[] getTypes()
public boolean getFilterByTypes()
public String toString()
public Object clone()
|
RSE Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |