Google Git
Sign in
eclipse / gerrit / www.eclipse.org / papyrus / 428351c841f94ec9a0f0359b890e9703e4d9539e / . / components / designer / 1.0.5 / xref / org / eclipse / papyrus / designer / languages / java / reverse / javaparser / ast / comments / CommentsCollection.html
blob: 65872c706eac4ae1dc499c37fe5811bb1f70b224 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>CommentsCollection xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../apidocs/org/eclipse/papyrus/designer/languages/java/reverse/javaparser/ast/comments/CommentsCollection.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_javadoccomment"> * All rights reserved. This program and the accompanying materials</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_javadoccomment"> * are made available under the terms of the Eclipse Public License v1.0</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_javadoccomment"> * which accompanies this distribution, and is available at</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_javadoccomment"> * <a href="http://www.eclipse.org/legal/epl-v10.htm" target="alexandria_uri">http://www.eclipse.org/legal/epl-v10.htm</a>l</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_javadoccomment"> * Contributors:</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * Copyright (C) 2007-2010 Júlio Vilmar Gesser.</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Copyright (C) 2011, 2013-2015 The JavaParser Team.</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * This file is part of JavaParser.</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * </em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * JavaParser can be used either under the terms of</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * a) the GNU Lesser General Public License as published by</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * the Free Software Foundation, either version 3 of the License, or</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> * (at your option) any later version.</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> * b) the terms of the Apache License </em>
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <em class="jxr_comment"> * You should have received a copy of both licenses in LICENCE.LGPL and</em>
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <em class="jxr_comment"> * LICENCE.APACHE. Please refer to those files for details.</em>
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_comment"> * JavaParser is distributed in the hope that it will be useful,</em>
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</em>
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</em>
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_comment"> * GNU Lesser General Public License for more details.</em>
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L29" href="#L29">29</a>
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">package</strong> org.eclipse.papyrus.designer.languages.java.reverse.javaparser.ast.comments;
<a class="jxr_linenumber" name="L31" href="#L31">31</a>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.util.LinkedList;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="L34" href="#L34">34</a>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * Set of comments produced by CommentsParser.</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../../../../org/eclipse/papyrus/designer/languages/java/reverse/javaparser/ast/comments/CommentsCollection.html">CommentsCollection</a> {
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">private</strong> List&lt;LineComment&gt; lineComments = <strong class="jxr_keyword">new</strong> LinkedList&lt;LineComment&gt;();
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">private</strong> List&lt;BlockComment&gt; blockComments = <strong class="jxr_keyword">new</strong> LinkedList&lt;BlockComment&gt;();
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">private</strong> List&lt;JavadocComment&gt; javadocComments = <strong class="jxr_keyword">new</strong> LinkedList&lt;JavadocComment&gt;();
<a class="jxr_linenumber" name="L42" href="#L42">42</a>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">public</strong> List&lt;LineComment&gt; getLineComments(){
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">return</strong> lineComments;
<a class="jxr_linenumber" name="L45" href="#L45">45</a> }
<a class="jxr_linenumber" name="L46" href="#L46">46</a>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">public</strong> List&lt;BlockComment&gt; getBlockComments(){
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">return</strong> blockComments;
<a class="jxr_linenumber" name="L49" href="#L49">49</a> }
<a class="jxr_linenumber" name="L50" href="#L50">50</a>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">public</strong> List&lt;JavadocComment&gt; getJavadocComments(){
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">return</strong> javadocComments;
<a class="jxr_linenumber" name="L53" href="#L53">53</a> }
<a class="jxr_linenumber" name="L54" href="#L54">54</a>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addComment(<a href="../../../../../../../../../../org/eclipse/papyrus/designer/languages/java/reverse/javaparser/ast/comments/LineComment.html">LineComment</a> lineComment){
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">this</strong>.lineComments.add(lineComment);
<a class="jxr_linenumber" name="L57" href="#L57">57</a> }
<a class="jxr_linenumber" name="L58" href="#L58">58</a>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addComment(<a href="../../../../../../../../../../org/eclipse/papyrus/designer/languages/java/reverse/javaparser/ast/comments/BlockComment.html">BlockComment</a> blockComment){
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">this</strong>.blockComments.add(blockComment);
<a class="jxr_linenumber" name="L61" href="#L61">61</a> }
<a class="jxr_linenumber" name="L62" href="#L62">62</a>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addComment(<a href="../../../../../../../../../../org/eclipse/papyrus/designer/languages/java/reverse/javaparser/ast/comments/JavadocComment.html">JavadocComment</a> javadocComment){
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">this</strong>.javadocComments.add(javadocComment);
<a class="jxr_linenumber" name="L65" href="#L65">65</a> }
<a class="jxr_linenumber" name="L66" href="#L66">66</a>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> contains(<a href="../../../../../../../../../../org/eclipse/papyrus/designer/languages/java/reverse/javaparser/ast/comments/Comment.html">Comment</a> comment){
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">for</strong> (Comment c : getAll()){
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_comment">// we tollerate a difference of one element in the end column:</em>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_comment">// it depends how \r and \n are calculated...</em>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">if</strong> ( c.getBeginLine()==comment.getBeginLine() &amp;&amp;
<a class="jxr_linenumber" name="L72" href="#L72">72</a> c.getBeginColumn()==comment.getBeginColumn() &amp;&amp;
<a class="jxr_linenumber" name="L73" href="#L73">73</a> c.getEndLine()==comment.getEndLine() &amp;&amp;
<a class="jxr_linenumber" name="L74" href="#L74">74</a> Math.abs(c.getEndColumn()-comment.getEndColumn())&lt;2 ){
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L76" href="#L76">76</a> }
<a class="jxr_linenumber" name="L77" href="#L77">77</a> }
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="L79" href="#L79">79</a> }
<a class="jxr_linenumber" name="L80" href="#L80">80</a>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">public</strong> List&lt;Comment&gt; getAll(){
<a class="jxr_linenumber" name="L82" href="#L82">82</a> List&lt;Comment&gt; comments = <strong class="jxr_keyword">new</strong> LinkedList&lt;Comment&gt;();
<a class="jxr_linenumber" name="L83" href="#L83">83</a> comments.addAll(lineComments);
<a class="jxr_linenumber" name="L84" href="#L84">84</a> comments.addAll(blockComments);
<a class="jxr_linenumber" name="L85" href="#L85">85</a> comments.addAll(javadocComments);
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">return</strong> comments;
<a class="jxr_linenumber" name="L87" href="#L87">87</a> }
<a class="jxr_linenumber" name="L88" href="#L88">88</a>
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> size(){
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">return</strong> lineComments.size()+blockComments.size()+javadocComments.size();
<a class="jxr_linenumber" name="L91" href="#L91">91</a> }
<a class="jxr_linenumber" name="L92" href="#L92">92</a>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../../../../org/eclipse/papyrus/designer/languages/java/reverse/javaparser/ast/comments/CommentsCollection.html">CommentsCollection</a> minus(<a href="../../../../../../../../../../org/eclipse/papyrus/designer/languages/java/reverse/javaparser/ast/comments/CommentsCollection.html">CommentsCollection</a> other){
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <a href="../../../../../../../../../../org/eclipse/papyrus/designer/languages/java/reverse/javaparser/ast/comments/CommentsCollection.html">CommentsCollection</a> result = <strong class="jxr_keyword">new</strong> <a href="../../../../../../../../../../org/eclipse/papyrus/designer/languages/java/reverse/javaparser/ast/comments/CommentsCollection.html">CommentsCollection</a>();
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">for</strong> (LineComment comment : lineComments){
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">if</strong> (!other.contains(comment)){
<a class="jxr_linenumber" name="L97" href="#L97">97</a> result.lineComments.add(comment);
<a class="jxr_linenumber" name="L98" href="#L98">98</a> }
<a class="jxr_linenumber" name="L99" href="#L99">99</a> }
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">for</strong> (BlockComment comment : blockComments){
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">if</strong> (!other.contains(comment)){
<a class="jxr_linenumber" name="L102" href="#L102">102</a> result.blockComments.add(comment);
<a class="jxr_linenumber" name="L103" href="#L103">103</a> }
<a class="jxr_linenumber" name="L104" href="#L104">104</a> }
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">for</strong> (JavadocComment comment : javadocComments){
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">if</strong> (!other.contains(comment)){
<a class="jxr_linenumber" name="L107" href="#L107">107</a> result.javadocComments.add(comment);
<a class="jxr_linenumber" name="L108" href="#L108">108</a> }
<a class="jxr_linenumber" name="L109" href="#L109">109</a> }
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">return</strong> result;
<a class="jxr_linenumber" name="L111" href="#L111">111</a> }
<a class="jxr_linenumber" name="L112" href="#L112">112</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2016&#x2013;2017 <a href="https://www.eclipse.org/">Eclipse foundation</a>. All rights reserved.</div>
</body>
</html>