001/*
002 * MIT License
003 * 
004 * Copyright (c) 2016 Michael Angstadt
005 * 
006 * Permission is hereby granted, free of charge, to any person obtaining a copy
007 * of this software and associated documentation files (the "Software"), to deal
008 * in the Software without restriction, including without limitation the rights
009 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
010 * copies of the Software, and to permit persons to whom the Software is
011 * furnished to do so, subject to the following conditions:
012 * 
013 * The above copyright notice and this permission notice shall be included in
014 * all copies or substantial portions of the Software.
015 * 
016 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
017 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
018 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
019 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
020 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
021 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
022 * SOFTWARE.
023 */
024
025package com.github.mangstadt.vinnie.io;
026
027import java.util.Collections;
028import java.util.List;
029
030/**
031 * Contains information related to the status of a parse operation, such as the
032 * parent component hierarchy and line number.
033 * @author Michael Angstadt
034 * @see VObjectDataListener
035 */
036public class Context {
037        final List<String> parentComponents;
038        final Buffer unfoldedLine = new Buffer();
039        int lineNumber = 1;
040        boolean stop = false;
041
042        Context(List<String> parentComponents) {
043                this.parentComponents = Collections.unmodifiableList(parentComponents);
044        }
045
046        /**
047         * Gets the hierarchy of parent components the parser is currently inside
048         * of, starting with the outer-most component.
049         * @return the component names (in uppercase; this list is immutable)
050         */
051        public List<String> getParentComponents() {
052                return parentComponents;
053        }
054
055        /**
056         * Gets the raw, unfolded line that was parsed.
057         * @return the raw, unfolded line
058         */
059        public String getUnfoldedLine() {
060                return unfoldedLine.get();
061        }
062
063        /**
064         * Gets the line number of the parsed line. If the line was folded, this
065         * will be the line number of the first line.
066         * @return the line number
067         */
068        public int getLineNumber() {
069                return lineNumber;
070        }
071
072        /**
073         * Instructs the parser to stop parsing and return from the call to
074         * {@link VObjectReader#parse}.
075         */
076        public void stop() {
077                stop = true;
078        }
079
080        @Override
081        public String toString() {
082                return "Context [parentComponents=" + parentComponents + ", unfoldedLine=" + unfoldedLine.get() + ", lineNumber=" + lineNumber + ", stop=" + stop + "]";
083        }
084}