net.sf.jsefa.common.lowlevel.io.LineSegment Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsefa-android Show documentation

JSefa (Java Simple exchange format api) is a simple library for stream-based serialization of java objects to XML, CSV, FLR or any other format and back again using an iterator-style interface independent of the serialization format. The mapping between java object types and types of the serialization format (e. g. xml complex element types) can be defined either by annotating the java classes or programmatically using a simple API. The current implementation supports XML, CSV and FLR - for XML it is based on JSR 173.

The newest version!

/*
 * Copyright 2007 the original author or authors.
 *
 * 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 net.sf.jsefa.common.lowlevel.io;

/**
 * A segment of a line of a stream.
 * A LineSegement consists of a content, a line and column number within the stream (regarding
 * the start of the content) and a terminator.
 * Note: The line number and the column number starts both with 1.
 * 
 * @author Norman Lahme-Huetig
 */
public final class LineSegment {
    private String content;
    private int lineNumber;
    private int columnNumber;
    private Terminator terminator;

    /**
     * Different types of content terminators.
     * 
     * @author Norman Lahme-Huetig
     */
    public enum Terminator {
        
        /**
         * Indicates that the line segment was terminated by a line break. 
         */
        LINE_BREAK,
        
        /**
         * Indicates that the line segment was terminated by a special termination character.
         */
        SPECIAL_CHARACTER,
        
        /**
         * Indicates that the line segment was terminated by the end of the stream.
         */
        EOS,
        
        /**
         * Indicates that the line segment is not terminated at all - thus it is incomplete (truncated).
         */
        NONE
    }

    /**
     * Constructs a new LineSegment.
     * @param content the content
     * @param lineNumber the line number
     * @param columnNumber the column number
     * @param terminator the terminator
     */
    public LineSegment(String content, int lineNumber, int columnNumber, Terminator terminator) {
        super();
        this.content = content;
        this.lineNumber = lineNumber;
        this.columnNumber = columnNumber;
        this.terminator = terminator;
    }

    /**
     * @return the content
     */
    public String getContent() {
        return content;
    }

    /**
     * @return the line number (starting with 1)
     */
    public int getLineNumber() {
        return lineNumber;
    }

    /**
     * @return the column number (starting with 1)
     */
    public int getColumnNumber() {
        return columnNumber;
    }

    /**
     * @return the terminator
     */
    public Terminator getTerminator() {
        return terminator;
    }

}