org.apache.felix.obrplugin

Class ResourcesBundle

public class ResourcesBundle extends Object

this class describe all information by bundle.

Author: Felix Project Team

Constructor Summary
ResourcesBundle(Log log)
initialize logger.
Method Summary
voidaddCapability(Capability capability)
add a new capability for this bundle description.
voidaddCategory(Category category)
add a new category for this bundle decription.
voidaddRequire(Require require)
add a new requirement for this bundle description.
booleanconstruct(MavenProject project, ExtractBindexInfo ebi, String sourcePath, String javadocPath)
this method gets information form pom.xml to complete missing data from those given by user.
ListgetCapability()
ListgetCategory()
StringgetDescription()
StringgetDocumentation()
StringgetId()
StringgetJavadoc()
StringgetLicense()
NodegetNode(Document father)
transform this object to Node. tranform all sub-object to node also
StringgetPresentationName()
ListgetRequire()
StringgetSize()
StringgetSource()
StringgetSymbolicName()
StringgetUri()
StringgetVersion()
booleanisSameBundleResource(String symbolicName, String version)
test if this bundle has the same symbolicname, and version number.
booleanisValid()
return if the bundle resource is complete.
voidsetCapability(List capability)
voidsetCategory(List category)
voidsetDescription(String description)
voidsetDocumentation(String documentation)
voidsetId(String id)
voidsetJavadoc(String javadoc)
voidsetLicense(String license)
voidsetPresentationName(String name)
voidsetRequire(List require)
voidsetSize(String size)
voidsetSource(String source)
voidsetSymbolicName(String name)
voidsetUri(String url)
voidsetVersion(String version)

Constructor Detail

ResourcesBundle

public ResourcesBundle(Log log)
initialize logger.

Parameters: log log use by plugin

Method Detail

addCapability

public void addCapability(Capability capability)
add a new capability for this bundle description.

Parameters: capability the Capability to add

addCategory

public void addCategory(Category category)
add a new category for this bundle decription.

Parameters: category the Category to add

addRequire

public void addRequire(Require require)
add a new requirement for this bundle description.

Parameters: require th Require to add

construct

public boolean construct(MavenProject project, ExtractBindexInfo ebi, String sourcePath, String javadocPath)
this method gets information form pom.xml to complete missing data from those given by user.

Parameters: project project information given by maven ebi bundle information extracted from bindex sourcePath path to local sources javadocPath path to local javadocs

Returns: true

getCapability

public List getCapability()

getCategory

public List getCategory()

getDescription

public String getDescription()

getDocumentation

public String getDocumentation()

getId

public String getId()

getJavadoc

public String getJavadoc()

getLicense

public String getLicense()

getNode

public Node getNode(Document father)
transform this object to Node. tranform all sub-object to node also

Parameters: father father document for create Node

Returns: node

getPresentationName

public String getPresentationName()

getRequire

public List getRequire()

getSize

public String getSize()

getSource

public String getSource()

getSymbolicName

public String getSymbolicName()

getUri

public String getUri()

getVersion

public String getVersion()

isSameBundleResource

public boolean isSameBundleResource(String symbolicName, String version)
test if this bundle has the same symbolicname, and version number.

Parameters: symbolicName symbolicName to compare with current bundle presentationName presentationName to compare with current bundlde version version to compare with current bundle

Returns: true if the information are the same, else false

isValid

public boolean isValid()
return if the bundle resource is complete.

Returns: false if an information is missing, else true

setCapability

public void setCapability(List capability)

setCategory

public void setCategory(List category)

setDescription

public void setDescription(String description)

setDocumentation

public void setDocumentation(String documentation)

setId

public void setId(String id)

setJavadoc

public void setJavadoc(String javadoc)

setLicense

public void setLicense(String license)

setPresentationName

public void setPresentationName(String name)

setRequire

public void setRequire(List require)

setSize

public void setSize(String size)

setSource

public void setSource(String source)

setSymbolicName

public void setSymbolicName(String name)

setUri

public void setUri(String url)

setVersion

public void setVersion(String version)
Copyright © 2006-2009 Apache Software Foundation. All Rights Reserved.