Class ApiRegion
- java.lang.Object
-
- org.apache.sling.feature.extension.apiregions.api.ApiRegion
-
public class ApiRegion extends Object
Describes an api region for Java API This class is not thread safe.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanadd(ApiExport export)Add the export.booleanequals(Object obj)ApiExportgetAllExportByName(String name)Get an export by nameApiExportgetExportByName(String name)Get an export by nameorg.apache.sling.feature.ArtifactId[]getFeatureOrigins()StringgetName()Get the name of the regionApiRegiongetParent()Get the parent regionMap<String,String>getProperties()Get additional propertiesinthashCode()booleanisEmpty()Check if the region has exportsCollection<ApiExport>listAllExports()Unmodifiable collection of exports for this region and all parents.Collection<ApiExport>listExports()Unmodifiable collection of exports for this regionbooleanremove(ApiExport export)Remove the exportvoidsetFeatureOrigins(org.apache.sling.feature.ArtifactId... featureOrigins)StringtoString()
-
-
-
Field Detail
-
GLOBAL
public static final String GLOBAL
Name of the global region.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ApiRegion
public ApiRegion(String name)
Create a new named region- Parameters:
name- The name
-
-
Method Detail
-
getName
public String getName()
Get the name of the region- Returns:
- The region name
-
getFeatureOrigins
public org.apache.sling.feature.ArtifactId[] getFeatureOrigins()
-
setFeatureOrigins
public void setFeatureOrigins(org.apache.sling.feature.ArtifactId... featureOrigins)
-
add
public boolean add(ApiExport export)
Add the export. The export is only added if there isn't already a export with the same name- Parameters:
export- The export to add- Returns:
trueif the export could be added,falseotherwise
-
remove
public boolean remove(ApiExport export)
Remove the export- Parameters:
export- export to remove- Returns:
trueif the export got removed.
-
isEmpty
public boolean isEmpty()
Check if the region has exports- Returns:
trueif it has any export
-
listExports
public Collection<ApiExport> listExports()
Unmodifiable collection of exports for this region- Returns:
- The collection of exports
-
listAllExports
public Collection<ApiExport> listAllExports()
Unmodifiable collection of exports for this region and all parents.- Returns:
- The collection of exports
-
getExportByName
public ApiExport getExportByName(String name)
Get an export by name- Parameters:
name- package name- Returns:
- The export or
null
-
getAllExportByName
public ApiExport getAllExportByName(String name)
Get an export by name- Parameters:
name- package name- Returns:
- The export or
null
-
getProperties
public Map<String,String> getProperties()
Get additional properties- Returns:
- Modifiable map of properties
-
getParent
public ApiRegion getParent()
Get the parent region- Returns:
- The parent region or
null
-
-