aboutsummaryrefslogtreecommitdiffstats
path: root/javaparser-core/src/main/java/com/github/javaparser/javadoc/description/JavadocSnippet.java
diff options
context:
space:
mode:
Diffstat (limited to 'javaparser-core/src/main/java/com/github/javaparser/javadoc/description/JavadocSnippet.java')
-rw-r--r--javaparser-core/src/main/java/com/github/javaparser/javadoc/description/JavadocSnippet.java67
1 files changed, 67 insertions, 0 deletions
diff --git a/javaparser-core/src/main/java/com/github/javaparser/javadoc/description/JavadocSnippet.java b/javaparser-core/src/main/java/com/github/javaparser/javadoc/description/JavadocSnippet.java
new file mode 100644
index 000000000..50b32cb31
--- /dev/null
+++ b/javaparser-core/src/main/java/com/github/javaparser/javadoc/description/JavadocSnippet.java
@@ -0,0 +1,67 @@
+/*
+ * Copyright (C) 2007-2010 JĂșlio Vilmar Gesser.
+ * Copyright (C) 2011, 2013-2016 The JavaParser Team.
+ *
+ * This file is part of JavaParser.
+ *
+ * JavaParser can be used either under the terms of
+ * a) the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * b) the terms of the Apache License
+ *
+ * You should have received a copy of both licenses in LICENCE.LGPL and
+ * LICENCE.APACHE. Please refer to those files for details.
+ *
+ * JavaParser is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ */
+
+package com.github.javaparser.javadoc.description;
+
+/**
+ * A piece of text inside a Javadoc description.
+ * <p>
+ * For example in <code>A class totally unrelated to {@link String}, I swear!</code> we would have two snippets: one
+ * before and one after the inline tag (<code>{@link String}</code>).
+ */
+public class JavadocSnippet implements JavadocDescriptionElement {
+ private String text;
+
+ public JavadocSnippet(String text) {
+ if (text == null) {
+ throw new NullPointerException();
+ }
+ this.text = text;
+ }
+
+ @Override
+ public String toText() {
+ return this.text;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+
+ JavadocSnippet that = (JavadocSnippet) o;
+
+ return text.equals(that.text);
+
+ }
+
+ @Override
+ public int hashCode() {
+ return text.hashCode();
+ }
+
+ @Override
+ public String toString() {
+ return "JavadocSnippet{" +
+ "text='" + text + '\'' +
+ '}';
+ }
+}