com.google.api.tools.framework.model

Class SimpleLocation

java.lang.Object

com.google.api.tools.framework.model.SimpleLocation

All Implemented Interfaces:

Location

public class SimpleLocation
extends java.lang.Object
implements Location

A simple location with a directly specified display string.

Field Summary

Fields

Modifier and Type	Field and Description
static Location	TOPLEVEL
static Location	UNKNOWN

Constructor Summary

Constructors

Constructor and Description
SimpleLocation(java.lang.String displayString) Creates a simple location with just the display string.
SimpleLocation(java.lang.String displayString, java.lang.String containerName) Creates a simple location with display string and the container name.

Method Summary

Modifier and Type	Method and Description
static Location	convertFrom(com.google.protobuf.DescriptorProtos.SourceCodeInfo.Location location, ProtoElement element) Create new instance of SimpleLocation by converting from instance of DescriptorProtos.SourceCodeInfo.Location
boolean	equals(java.lang.Object obj)
java.lang.String	getContainerName() Get the name of the containing entity of this location, in most cases its a file name.
java.lang.String	getDisplayString() Get the location as a string readable to users and interpretable by IDEs.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TOPLEVEL

public static final Location TOPLEVEL

UNKNOWN

public static final Location UNKNOWN

Constructor Detail

SimpleLocation

public SimpleLocation(java.lang.String displayString)

Creates a simple location with just the display string. containerName is set to displayString.

SimpleLocation

public SimpleLocation(java.lang.String displayString,
                      java.lang.String containerName)

Creates a simple location with display string and the container name.

Method Detail

convertFrom

public static Location convertFrom(com.google.protobuf.DescriptorProtos.SourceCodeInfo.Location location,
                                   ProtoElement element)

Create new instance of SimpleLocation by converting from instance of DescriptorProtos.SourceCodeInfo.Location

The Display String structure is "proto name:line number:column number".

Parameters:

location - Instance DescriptorProtos.SourceCodeInfo.Location

element - ProtoElement associated with the given location.

getDisplayString

public java.lang.String getDisplayString()

Description copied from interface: Location

Get the location as a string readable to users and interpretable by IDEs. The actual semantics depends on the underlying source type. This may or not be the same as toString().

Specified by:

getDisplayString in interface Location

getContainerName

public java.lang.String getContainerName()

Description copied from interface: Location

Get the name of the containing entity of this location, in most cases its a file name.

Specified by:

getContainerName in interface Location

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object