diff --git a/converter-sbml/src/main/java/lcsb/mapviewer/converter/model/sbml/NotesUtility.java b/converter-sbml/src/main/java/lcsb/mapviewer/converter/model/sbml/NotesUtility.java index faf50e78437ab16bc9270fee817760d73db0321c..d1ca33fbdaabcc01a7409241573e546a247bb3c9 100644 --- a/converter-sbml/src/main/java/lcsb/mapviewer/converter/model/sbml/NotesUtility.java +++ b/converter-sbml/src/main/java/lcsb/mapviewer/converter/model/sbml/NotesUtility.java @@ -1,5 +1,4 @@ package lcsb.mapviewer.converter.model.sbml; - import javax.xml.stream.XMLStreamException; import org.apache.commons.lang3.StringEscapeUtils; @@ -7,7 +6,24 @@ import org.sbml.jsbml.AbstractNamedSBase; import lcsb.mapviewer.converter.InvalidInputDataExecption; +/** + * This utility class parses notes from SBML node and prepares escaped string + * ready to use in SBML. + * + * @author Piotr Gawron + * + */ public class NotesUtility { + + /** + * Extract notes from SBML node + * + * @param sbmlElement + * SBML node + * @return notes + * @throws InvalidInputDataExecption + * thrown when there is problem with extracting notes + */ public static String extractNotes(AbstractNamedSBase sbmlElement) throws InvalidInputDataExecption { String notes = ""; try { @@ -29,6 +45,13 @@ public class NotesUtility { return notes; } + /** + * Prepares escaped xml string with notes. + * + * @param notes + * notes to be processed + * @return escaped xml string with notes + */ public static String prepareEscapedXmlNotes(String notes) { if (notes == null) { return "";