public class ContentFolder
extends java.lang.Object
Constructor and Description |
---|
ContentFolder(java.net.URL contentFolderURL)
Constructs a
ContentFolder . |
ContentFolder(java.net.URL contentFolderURL, PatternFilter[] filters)
Constructs a
ContentFolder where contentFolderURL is the URL of the content folder. |
ContentFolder(java.net.URL contentFolderURL, java.net.URL srcRootURL)
Creates a new
ContentFolder . |
ContentFolder(java.net.URL contentFolderURL, java.net.URL srcRootURL, PatternFilter[] filters)
Creates a new
ContentFolder . |
Modifier and Type | Method and Description |
---|---|
void |
addFilter(PatternFilter patternFilter)
Adds the supplied filter to the list of filters for this content folder.
|
void |
addRelativeExcludeFilter(java.lang.String excludePattern)
Adds an exclude
PatternFilter with the supplied pattern. |
void |
addRelativeIncludeFilter(java.lang.String includePattern)
Adds an include
PatternFilter with the supplied pattern. |
boolean |
equals(java.lang.Object object) |
PatternFilter[] |
getAllFilters()
Returns the filters for this content folder.
|
java.net.URL |
getContentFolderURL()
Gets the URL for the content folder.
|
PatternFilter |
getPrimaryIncludeFilter()
Gets the
PatternFilter that defines the default inclusion pattern for this ContentFolder . |
java.net.URL |
getRootURL()
Gets the root URL for this content folder.
|
void |
setIncludeSubfolders(boolean include)
Specifies whether or not subfolders are included.
|
java.lang.String |
toString() |
public ContentFolder(java.net.URL contentFolderURL)
ContentFolder
. The contentFolderURL
is the URL of the content folder.
Note: For Java content sets, if the content folder is a subfolder undera source root, you must also specify the URL for the source root. In this case, use ContentFolder(URL, URL)
or ContentFolder(URL, URL, PatternFilter[])
.
contentFolderURL
- the content folder URLContentFolder(URL, URL)
, ContentFolder(URL, PatternFilter[])
, ContentFolder(URL, URL, PatternFilter[])
public ContentFolder(java.net.URL contentFolderURL, PatternFilter[] filters)
ContentFolder
where contentFolderURL
is the URL of the content folder. The supplied filters should be those associated with the content folder in the ContentSet
.
Note: For Java content sets, if the content folder is a subfolder undera source root, you must also specify the URL for the source root. In this case, use ContentFolder(URL, URL)
.
contentFolderURL
- the content folder URLfilters
- the pattern filters assoicated with this URL, or null
.ContentFolder(URL)
, ContentFolder(URL, URL)
, ContentFolder(URL, URL, PatternFilter[])
public ContentFolder(java.net.URL contentFolderURL, java.net.URL srcRootURL)
ContentFolder
. This constructor is especially useful for Java ContentSets which must have a source root, and optiontionally, might have a content folder which is a subfolder of that root.
The srcRootURL
can be null
, in which case it is assumed that the supplied contentFolderURL
is the source root. Otherwise, contentFolderURL
must be a subfolder under srcRootURL.
contentFolderURL
- the content folder URLsrcRootURL
- the source root for the content, or null if contentFolderURL
is also the source rootjava.lang.IllegalArgumentException
- If the contentFolderURL
is not under the srcRootURL.
ContentFolder(URL)
, ContentFolder(URL, PatternFilter[])
, ContentFolder(URL, URL, PatternFilter[])
public ContentFolder(java.net.URL contentFolderURL, java.net.URL srcRootURL, PatternFilter[] filters)
ContentFolder
. This constructor is especially useful for Java ContentSets which must have a source root, and optiontionally, might have a content folder which is a subfolder of that root.
The srcRootURL
can be null
, in which case it is assumed that the supplied contentFolderURL
is the source root. Otherwise, contentFolderURL
must be a subfolder under srcRootURL.
contentFolderURL
- the content folder URLsrcRootURL
- the source root for the content, or null if contentFolderURL
is also the source rootfilters
- the pattern filters assoicated with this URL, or null
java.lang.IllegalArgumentException
- If the contentFolderURL
is not under the srcRootURL.
ContentFolder(URL)
, ContentFolder(URL, URL)
, ContentFolder(URL, PatternFilter[])
public PatternFilter getPrimaryIncludeFilter()
PatternFilter
that defines the default inclusion pattern for this ContentFolder
. For ContentFolder
s where the source root is the content folder, this will return an include-all filter. Otherwise, it will return an include for the subfolder relative to the root.public void addRelativeExcludeFilter(java.lang.String excludePattern)
PatternFilter
with the supplied pattern.excludePattern
- the pattern for the PatternFilter
PatternFilter
public void addFilter(PatternFilter patternFilter)
patternFilter
- the filter to add; patternFilter
must not be null
public void addRelativeIncludeFilter(java.lang.String includePattern)
PatternFilter
with the supplied pattern.includePattern
- the pattern for the PatternFilter
PatternFilter
public java.net.URL getRootURL()
getContentFolderURL()
public java.net.URL getContentFolderURL()
getRootURL()
public void setIncludeSubfolders(boolean include)
include
- use true to include subfolderspublic PatternFilter[] getAllFilters()
PatternFilter
s.public boolean equals(java.lang.Object object)
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object