
org.yaml.snakeyaml.events.DocumentStartEvent Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.liferay.portal.tools.rest.builder
Show all versions of com.liferay.portal.tools.rest.builder
Liferay Portal Tools REST Builder
The newest version!
/**
* 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
*
* 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.
*/
package org.yaml.snakeyaml.events;
import java.util.Map;
import org.yaml.snakeyaml.DumperOptions.Version;
import org.yaml.snakeyaml.error.Mark;
/**
* Marks the beginning of a document.
*
* This event followed by the document's content and a {@link DocumentEndEvent}.
*
*/
public final class DocumentStartEvent extends Event {
private final boolean explicit;
private final Version version;
private final Map tags;
/**
* Create
*
* @param startMark - start
* @param endMark - end
* @param explicit - true when it is present in the document
* @param version - YAML version
* @param tags - tag directives
*/
public DocumentStartEvent(Mark startMark, Mark endMark, boolean explicit, Version version,
Map tags) {
super(startMark, endMark);
this.explicit = explicit;
this.version = version;
this.tags = tags;
}
/**
* getter
*
* @return true when document end is present
*/
public boolean getExplicit() {
return explicit;
}
/**
* YAML version the document conforms to.
*
* @return null
if the document has no explicit %YAML
directive.
* Otherwise an array with two components, the major and minor part of the version (in
* this order).
*/
public Version getVersion() {
return version;
}
/**
* Tag shorthands as defined by the %TAG
directive.
*
* @return Mapping of 'handles' to 'prefixes' (the handles include the '!' characters).
*/
public Map getTags() {
return tags;
}
@Override
public Event.ID getEventId() {
return ID.DocumentStart;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy