net.jini.config
Class ConfigurationFile.ErrorDescriptor

java.lang.Object
  extended by net.jini.config.ConfigurationFile.ErrorDescriptor
All Implemented Interfaces:
Serializable
Enclosing class:
ConfigurationFile

public static class ConfigurationFile.ErrorDescriptor
extends Object
implements Serializable

Class used to represent a syntax error encountered when parsing a configuration source or a problem encountered when attempting to return an existing entry or the type of an existing entry.

See Also:
Serialized Form

Field Summary
private  String description
          textual description of the problem encountered
private  int lineno
          line number where this syntax error occurred
private  String locationName
          configuration source location name
private  int override
          override where this syntax error occurred
private static long serialVersionUID
           
private  Throwable t
          exception associated with this error
 
Constructor Summary
ConfigurationFile.ErrorDescriptor(int lineno, int override, String description)
          Creates a new error descriptor.
ConfigurationFile.ErrorDescriptor(int lineno, int override, String description, String locationName)
          Creates a new error descriptor.
ConfigurationFile.ErrorDescriptor(int lineno, int override, String description, String locationName, Throwable t)
          Creates a new error descriptor.
 
Method Summary
 Throwable getCause()
          Returns the exception associated with this error or null if there is no exception associated with this error.
 String getDescription()
          Returns a textual description of the error encountered.
 int getLineNumber()
          Returns the line number in the configuration source where the entry with an error can be found or 0 if this error descriptor is not associated with a line number.
 String getLocationName()
          Returns the name of the configuration source location or null if location information is not available.
 int getOverride()
          Returns the override sequence number where this error occurred or 0 if the error did not occur in an override.
private  void readObject(ObjectInputStream in)
          Verifies that the deserialized field values for this error descriptor are valid.
private  void readObjectNoData()
          Throws InvalidObjectException, since a descriptor is always required.
 String toString()
          Returns a string representation of this error.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

lineno

private final int lineno
line number where this syntax error occurred


override

private final int override
override where this syntax error occurred


description

private final String description
textual description of the problem encountered


locationName

private final String locationName
configuration source location name


t

private final Throwable t
exception associated with this error

Constructor Detail

ConfigurationFile.ErrorDescriptor

public ConfigurationFile.ErrorDescriptor(int lineno,
                                         int override,
                                         String description,
                                         String locationName,
                                         Throwable t)
Creates a new error descriptor.

Parameters:
lineno - line number of the configuration source where this problem was found or 0 if this problem is not associated with a line number
override - the override sequence number or 0 if the problem was not found in an override
description - a description of the problem; this parameter cannot be null
locationName - the name of the configuration source location or null if location information is not available
t - exception associated with this error or null if there is no exception related to the error; t cannot be an instance of java.lang.Error
Throws:
IllegalArgumentException - if lineno < 0, override < 0, description is null, or t is an instance of java.lang.Error

ConfigurationFile.ErrorDescriptor

public ConfigurationFile.ErrorDescriptor(int lineno,
                                         int override,
                                         String description,
                                         String locationName)
Creates a new error descriptor.

Parameters:
lineno - line number of the configuration source where this problem was found or 0 if this problem is not associated with a line number
override - the override sequence number or 0 if the problem was not found in an override
description - a description of the problem; this parameter cannot be null
locationName - the name of the configuration source location or null if location information is not available
Throws:
IllegalArgumentException - if lineno < 0, override < 0, or description is null

ConfigurationFile.ErrorDescriptor

public ConfigurationFile.ErrorDescriptor(int lineno,
                                         int override,
                                         String description)
Creates a new error descriptor.

Parameters:
lineno - line number of the configuration source where this problem was found or 0 if this problem is not associated with a line number
override - the override sequence number or 0 if the problem was not found in an override
description - a description of the problem; this parameter cannot be null
Throws:
IllegalArgumentException - if lineno < 0, override < 0, or description is null
Method Detail

getLineNumber

public int getLineNumber()
Returns the line number in the configuration source where the entry with an error can be found or 0 if this error descriptor is not associated with a line number.

Returns:
the line number in the configuration source where the entry with an error can be found or 0 if this error descriptor is not associated with a line number

getOverride

public int getOverride()
Returns the override sequence number where this error occurred or 0 if the error did not occur in an override. For example, if the error occurred in the second override specified, the method would return 2.

Returns:
the override where this error occurred or 0 if this error did not occur in an override

getDescription

public String getDescription()
Returns a textual description of the error encountered.

Returns:
a description of the problem

getLocationName

public String getLocationName()
Returns the name of the configuration source location or null if location information is not available.

Returns:
the name of the configuration source location where this error occurred or null if location information is not available.

getCause

public Throwable getCause()
Returns the exception associated with this error or null if there is no exception associated with this error.

Returns:
the exception associated with this error or null if there is no exception associated with this error.

toString

public String toString()
Returns a string representation of this error.

Overrides:
toString in class Object
Returns:
the string representation of this error

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException
Verifies that the deserialized field values for this error descriptor are valid.

Throws:
IOException
ClassNotFoundException

readObjectNoData

private void readObjectNoData()
                       throws ObjectStreamException
Throws InvalidObjectException, since a descriptor is always required.

Throws:
ObjectStreamException


Copyright 2007-2010, multiple authors.
Licensed under the Apache License, Version 2.0, see the NOTICE file for attributions.