ns1errorstate.java

这是一款基于PlaceLab软件开发的导航系统中间件的客户端程序.

// -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vim:ts=2:sw=2:tw=80:et

// $Id: Ns1ErrorState.java,v 1.2 2004/06/03 18:13:30 jscott Exp $
/* 
 * Copyright (c) 2003, Hugh Kennedy
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. Neither the name of the WiGLE.net nor Mimezine nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package org.placelab.util.ns1;



/**
 * hold errors related to decoding .ns1 binary files.
 */
public class Ns1ErrorState {

    /** was there an error? */
    private boolean error = false;

    /** what was the cause? */
    private String reason = "";

    /** at what byte offset from the start of the stream did the error occur? */
    private long offset = 0;

    /**
     * empty constructor for a non-error Ns1ErrorState
     */
    public Ns1ErrorState() {
    }

    /**
     * @return was there an error?
     */
    public boolean getError() {
        return error;
    }

    /**
     * @param err was there an error?
     */
    void setError( boolean err ) {
        error = err;
        if ( ! err ) {
            reason = "";
        }
    }

    /**
     * if getError() is true then there may be a reason.
     * @return the reason getError() returned true. "" if getError() returns false.
     */
    public String getReason() {
        return reason;
    }

    /**
     * @param why why is there an error?
     */
    void setReason( String why ) {
        reason = why;
    }

    /**
     * @return byte offset from the start of the input stream that the error occured.
     */
    public long getOffset() {
        return offset;
    }

    /**
     * @param pos byte offset from the start of the input stream that the error occured.
     */
    void setOffset( long pos ) {
        offset = pos;
    }
}