public interface IMapEntry
Note that the left and right strings are pure paths -- they do not contain (or should not contain) any leading include / exclude prefixes except where this is explicitly allowed (e.g. the special constructor).
Modifier and Type | Interface and Description |
---|---|
static class |
IMapEntry.EntryType
Defines the specific type of a given view map entry.
|
Modifier and Type | Field and Description |
---|---|
static int |
ORDER_UNKNOWN |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getComment()
Get the "comment" entry for this mapping; equivalent to
getComment(false).
|
java.lang.String |
getComment(boolean quoteBlanks)
Get the "comment" entry for this mapping.
|
java.lang.String |
getLeft()
Get the "left" entry for this mapping; equivalent to
getLeft(false).
|
java.lang.String |
getLeft(boolean quoteBlanks)
Get the "left" entry for this mapping.
|
int |
getOrder()
Get the order of this entry in the entry list, if known.
|
java.lang.String |
getRight()
Get the "right" entry for this mapping; equivalent to
getRight(false).
|
java.lang.String |
getRight(boolean quoteBlanks)
Get the "right" entry for this mapping.
|
IMapEntry.EntryType |
getType()
Return the view map type of this entry.
|
void |
setComment(java.lang.String comment)
Set the "comment" entry for this mapping.
|
void |
setLeft(java.lang.String left)
Set the "left" entry for this mapping.
|
void |
setOrder(int position)
Set the order of this entry in the entry list.
|
void |
setRight(java.lang.String right)
Set the "right" entry for this mapping.
|
void |
setType(IMapEntry.EntryType type)
Set this entry's type.
|
java.lang.String |
toString()
Alias for toString(" ", false).
|
java.lang.String |
toString(java.lang.String sepString,
boolean quoteBlanks)
Return a canonical String representation of this entry.
|
static final int ORDER_UNKNOWN
int getOrder()
void setOrder(int position)
position
- new orderIMapEntry.EntryType getType()
void setType(IMapEntry.EntryType type)
type
- new entry type. May be null.java.lang.String getLeft()
java.lang.String getLeft(boolean quoteBlanks)
quoteBlanks
- if true, and the left string
contains spaces or tabs the entire string is returned
surrounded by quote characters.void setLeft(java.lang.String left)
left
- possibly-null new left mapping entryjava.lang.String getRight()
java.lang.String getRight(boolean quoteBlanks)
quoteBlanks
- if true, and the right string
contains spaces or tabs the entire string is returned
surrounded by quote characters.void setRight(java.lang.String right)
right
- possibly-null new right mapping entryjava.lang.String getComment()
java.lang.String getComment(boolean quoteBlanks)
quoteBlanks
- if true, and the comment string
contains spaces or tabs the entire string is returned
surrounded by quote characters.void setComment(java.lang.String comment)
comment
- possibly-null new comment mapping entryjava.lang.String toString()
toString
in class java.lang.Object
java.lang.String toString(java.lang.String sepString, boolean quoteBlanks)
If the passed-in string is null, the left and right strings (if they exist) will be concatenated into one long separator-less string.
If the quoteBlanks parameter is true, if either or both the left or right entries contain spaces, the entries are quoted in full, i.e. the mapping //depot/test/space test 01/... //depot/test/space test 02/... becomes "//depot/test/space test 01/..." "//depot/test/space test 02/...".
sepString
- separator stringquoteBlanks
- quotes if spaces are used