add javadoc

Signed-off-by: Michael Hirsch <michael.hirsch@bosch-si.com>
This commit is contained in:
Michael Hirsch
2016-05-31 08:52:09 +02:00
parent 2d90900f37
commit b369369c2c

View File

@@ -49,8 +49,17 @@ public interface SoftwareModule extends NamedVersionedEntity {
*/ */
List<LocalArtifact> getLocalArtifacts(); List<LocalArtifact> getLocalArtifacts();
/**
* @return the vendor of this software module
*/
String getVendor(); String getVendor();
/**
* @param vendor
* the vendor of this software module to set
*/
void setVendor(String vendor);
/** /**
* @param artifact * @param artifact
* is removed from the assigned {@link LocalArtifact}s. * is removed from the assigned {@link LocalArtifact}s.
@@ -63,14 +72,30 @@ public interface SoftwareModule extends NamedVersionedEntity {
*/ */
void removeArtifact(ExternalArtifact artifact); void removeArtifact(ExternalArtifact artifact);
void setVendor(String vendor); /**
* @return the type of the software module
*/
SoftwareModuleType getType(); SoftwareModuleType getType();
/**
* @return {@code true} if this software module is marked as deleted
* otherwise {@code false}
*/
boolean isDeleted(); boolean isDeleted();
/**
* Marks or un-marks this software module as deleted.
*
* @param deleted
* {@code true} if the software module should be marked as
* deleted otherwise {@code false}
*/
void setDeleted(boolean deleted); void setDeleted(boolean deleted);
/**
* @param type
* the module type for this software module
*/
void setType(SoftwareModuleType type); void setType(SoftwareModuleType type);
/** /**