aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/org/yaml/snakeyaml/events/ScalarEvent.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/org/yaml/snakeyaml/events/ScalarEvent.java')
-rw-r--r--src/main/java/org/yaml/snakeyaml/events/ScalarEvent.java189
1 files changed, 110 insertions, 79 deletions
diff --git a/src/main/java/org/yaml/snakeyaml/events/ScalarEvent.java b/src/main/java/org/yaml/snakeyaml/events/ScalarEvent.java
index 7f07a62b..ed2ea0cc 100644
--- a/src/main/java/org/yaml/snakeyaml/events/ScalarEvent.java
+++ b/src/main/java/org/yaml/snakeyaml/events/ScalarEvent.java
@@ -1,101 +1,132 @@
/**
- * Copyright (c) 2008, http://www.snakeyaml.org
+ * Copyright (c) 2008, SnakeYAML
*
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing permissions and limitations under
+ * the License.
*/
package org.yaml.snakeyaml.events;
+import org.yaml.snakeyaml.DumperOptions;
import org.yaml.snakeyaml.error.Mark;
/**
* Marks a scalar value.
*/
public final class ScalarEvent extends NodeEvent {
- private final String tag;
- // style flag of a scalar event indicates the style of the scalar. Possible
- // values are None, '', '\'', '"', '|', '>'
- private final Character style;
- private final String value;
- // The implicit flag of a scalar event is a pair of boolean values that
- // indicate if the tag may be omitted when the scalar is emitted in a plain
- // and non-plain style correspondingly.
- private final ImplicitTuple implicit;
- public ScalarEvent(String anchor, String tag, ImplicitTuple implicit, String value,
- Mark startMark, Mark endMark, Character style) {
- super(anchor, startMark, endMark);
- this.tag = tag;
- this.implicit = implicit;
- this.value = value;
- this.style = style;
- }
+ private final String tag;
+ // style flag of a scalar event indicates the style of the scalar. Possible
+ // values are None, '', '\'', '"', '|', '>'
+ private final DumperOptions.ScalarStyle style;
+ private final String value;
+ // The implicit flag of a scalar event is a pair of boolean values that
+ // indicate if the tag may be omitted when the scalar is emitted in a plain
+ // and non-plain style correspondingly.
+ private final ImplicitTuple implicit;
- /**
- * Tag of this scalar.
- *
- * @return The tag of this scalar, or <code>null</code> if no explicit tag
- * is available.
- */
- public String getTag() {
- return this.tag;
+ public ScalarEvent(String anchor, String tag, ImplicitTuple implicit, String value,
+ Mark startMark, Mark endMark, DumperOptions.ScalarStyle style) {
+ super(anchor, startMark, endMark);
+ this.tag = tag;
+ this.implicit = implicit;
+ if (value == null) {
+ throw new NullPointerException("Value must be provided.");
}
-
- /**
- * Style of the scalar.
- * <dl>
- * <dt>null</dt>
- * <dd>Flow Style - Plain</dd>
- * <dt>'\''</dt>
- * <dd>Flow Style - Single-Quoted</dd>
- * <dt>'"'</dt>
- * <dd>Flow Style - Double-Quoted</dd>
- * <dt>'|'</dt>
- * <dd>Block Style - Literal</dd>
- * <dt>'>'</dt>
- * <dd>Block Style - Folded</dd>
- * </dl>
- *
- * @see <a href="http://yaml.org/spec/1.1/#id864487">Kind/Style
- * Combinations</a>
- * @return Style of the scalar.
- */
- public Character getStyle() {
- return this.style;
+ this.value = value;
+ if (style == null) {
+ throw new NullPointerException("Style must be provided.");
}
+ this.style = style;
+ }
- /**
- * String representation of the value.
- * <p>
- * Without quotes and escaping.
- * </p>
- *
- * @return Value as Unicode string.
- */
- public String getValue() {
- return this.value;
- }
+ /*
+ * Existed in older versions but replaced with {@link DumperOptions.ScalarStyle}-based
+ * constructor. Restored in v1.22 for backwards compatibility.
+ *
+ * @deprecated Since restored in v1.22. Use {@link ScalarEvent#ScalarEvent(String, String,
+ * ImplicitTuple, String, Mark, Mark, org.yaml.snakeyaml.DumperOptions.ScalarStyle) }.
+ */
+ @Deprecated
+ public ScalarEvent(String anchor, String tag, ImplicitTuple implicit, String value,
+ Mark startMark, Mark endMark, Character style) {
+ this(anchor, tag, implicit, value, startMark, endMark,
+ DumperOptions.ScalarStyle.createStyle(style));
+ }
- public ImplicitTuple getImplicit() {
- return this.implicit;
- }
+ /**
+ * Tag of this scalar.
+ *
+ * @return The tag of this scalar, or <code>null</code> if no explicit tag is available.
+ */
+ public String getTag() {
+ return this.tag;
+ }
- @Override
- protected String getArguments() {
- return super.getArguments() + ", tag=" + tag + ", " + implicit + ", value=" + value;
- }
+ /**
+ * Style of the scalar.
+ * <dl>
+ * <dt>null</dt>
+ * <dd>Flow Style - Plain</dd>
+ * <dt>'\''</dt>
+ * <dd>Flow Style - Single-Quoted</dd>
+ * <dt>'"'</dt>
+ * <dd>Flow Style - Double-Quoted</dd>
+ * <dt>'|'</dt>
+ * <dd>Block Style - Literal</dd>
+ * <dt>'&gt;'</dt>
+ * <dd>Block Style - Folded</dd>
+ * </dl>
+ *
+ * @see <a href="http://yaml.org/spec/1.1/#id864487">Kind/Style Combinations</a>
+ * @return Style of the scalar.
+ */
+ public DumperOptions.ScalarStyle getScalarStyle() {
+ return this.style;
+ }
- @Override
- public boolean is(Event.ID id) {
- return ID.Scalar == id;
- }
+ /**
+ * @deprecated use getScalarStyle() instead
+ * @return char which is a value behind ScalarStyle
+ */
+ @Deprecated
+ public Character getStyle() {
+ return this.style.getChar();
+ }
+
+ /**
+ * String representation of the value.
+ * <p>
+ * Without quotes and escaping.
+ * </p>
+ *
+ * @return Value as Unicode string.
+ */
+ public String getValue() {
+ return this.value;
+ }
+
+ public ImplicitTuple getImplicit() {
+ return this.implicit;
+ }
+
+ @Override
+ protected String getArguments() {
+ return super.getArguments() + ", tag=" + tag + ", " + implicit + ", value=" + value;
+ }
+
+ @Override
+ public Event.ID getEventId() {
+ return ID.Scalar;
+ }
+
+ public boolean isPlain() {
+ return style == DumperOptions.ScalarStyle.PLAIN;
+ }
}