org.dartlang.analysis.server.protocol.NavigationRegion Class Reference

Public Member Functions
	NavigationRegion (int offset, int length, int[] targets)
boolean	containsInclusive (int x)
boolean	equals (Object obj)
List< NavigationTarget >	getTargetObjects ()
int	getLength ()
int	getOffset ()
int[]	getTargets ()
int	hashCode ()
void	lookupTargets (List< NavigationTarget > allTargets)
JsonObject	toJson ()
String	toString ()

Static Public Member Functions
static NavigationRegion	fromJson (JsonObject jsonObject)
static List< NavigationRegion >	fromJsonArray (JsonArray jsonArray)

Static Public Attributes
static final NavigationRegion[]	EMPTY_ARRAY = new NavigationRegion[0]
static final List< NavigationRegion >	EMPTY_LIST = Lists.newArrayList()

Detailed Description

A description of a region from which the user can navigate to the declaration of an element.

@coverage dart.server.generated.types

Definition at line 32 of file NavigationRegion.java.

Constructor & Destructor Documentation

NavigationRegion()

org.dartlang.analysis.server.protocol.NavigationRegion.NavigationRegion ( int  offset, int  length, int[]  targets  )

inline

Constructor for NavigationRegion.

Definition at line 60 of file NavigationRegion.java.

                                                                 {
    this.offset = offset;
    this.length = length;
    this.targets = targets;
  }

Member Function Documentation

containsInclusive()

boolean org.dartlang.analysis.server.protocol.NavigationRegion.containsInclusive ( int  x )

inline

Definition at line 66 of file NavigationRegion.java.

                                          {
    return offset <= x && x <= offset + length;
  }

equals()

boolean org.dartlang.analysis.server.protocol.NavigationRegion.equals ( Object  obj )

inline

Definition at line 71 of file NavigationRegion.java.

                                    {
    if (obj instanceof NavigationRegion) {
      NavigationRegion other = (NavigationRegion) obj;
      return
        other.offset == offset &&
        other.length == length &&
        Arrays.equals(other.targets, targets);
    }
    return false;
  }

fromJson()

static NavigationRegion org.dartlang.analysis.server.protocol.NavigationRegion.fromJson ( JsonObject  jsonObject )

inlinestatic

Definition at line 82 of file NavigationRegion.java.

                                                                 {
    int offset = jsonObject.get("offset").getAsInt();
    int length = jsonObject.get("length").getAsInt();
    int[] targets = JsonUtilities.decodeIntArray(jsonObject.get("targets").getAsJsonArray());
    return new NavigationRegion(offset, length, targets);
  }

fromJsonArray()

static List< NavigationRegion > org.dartlang.analysis.server.protocol.NavigationRegion.fromJsonArray ( JsonArray  jsonArray )

inlinestatic

Definition at line 89 of file NavigationRegion.java.

                                                                          {
    if (jsonArray == null) {
      return EMPTY_LIST;
    }
    ArrayList<NavigationRegion> list = new ArrayList<NavigationRegion>(jsonArray.size());
    Iterator<JsonElement> iterator = jsonArray.iterator();
    while (iterator.hasNext()) {
      list.add(fromJson(iterator.next().getAsJsonObject()));
    }
    return list;
  }

getLength()

int org.dartlang.analysis.server.protocol.NavigationRegion.getLength ( )

inline

The length of the region from which the user can navigate.

Definition at line 108 of file NavigationRegion.java.

                         {
    return length;
  }

getOffset()

int org.dartlang.analysis.server.protocol.NavigationRegion.getOffset ( )

inline

The offset of the region from which the user can navigate.

Definition at line 115 of file NavigationRegion.java.

                         {
    return offset;
  }

getTargetObjects()

List< NavigationTarget > org.dartlang.analysis.server.protocol.NavigationRegion.getTargetObjects ( )

inline

Definition at line 101 of file NavigationRegion.java.

                                                   {
    return targetObjects;
  }

getTargets()

int[] org.dartlang.analysis.server.protocol.NavigationRegion.getTargets ( )

inline

The indexes of the targets (in the enclosing navigation response) to which the given region is bound. By opening the target, clients can implement one form of navigation. This list cannot be empty.

Definition at line 124 of file NavigationRegion.java.

                            {
    return targets;
  }

hashCode()

int org.dartlang.analysis.server.protocol.NavigationRegion.hashCode ( )

inline

Definition at line 129 of file NavigationRegion.java.

                        {
    HashCodeBuilder builder = new HashCodeBuilder();
    builder.append(offset);
    builder.append(length);
    builder.append(targets);
    return builder.toHashCode();
  }

lookupTargets()

void org.dartlang.analysis.server.protocol.NavigationRegion.lookupTargets ( List< NavigationTarget >  allTargets )

inline

Definition at line 137 of file NavigationRegion.java.

                                                               {
    for (int i = 0; i < targets.length; i++) {
      int targetIndex = targets[i];
      NavigationTarget target = allTargets.get(targetIndex);
      targetObjects.add(target);
    }
  }

toJson()

JsonObject org.dartlang.analysis.server.protocol.NavigationRegion.toJson ( )

inline

Definition at line 145 of file NavigationRegion.java.

                             {
    JsonObject jsonObject = new JsonObject();
    jsonObject.addProperty("offset", offset);
    jsonObject.addProperty("length", length);
    JsonArray jsonArrayTargets = new JsonArray();
    for (int elt : targets) {
      jsonArrayTargets.add(new JsonPrimitive(elt));
    }
    jsonObject.add("targets", jsonArrayTargets);
    return jsonObject;
  }

toString()

String org.dartlang.analysis.server.protocol.NavigationRegion.toString ( )

inline

Definition at line 158 of file NavigationRegion.java.

                           {
    StringBuilder builder = new StringBuilder();
    builder.append("[");
    builder.append("offset=");
    builder.append(offset + ", ");
    builder.append("length=");
    builder.append(length + ", ");
    builder.append("targets=");
    builder.append(StringUtils.join(targets, ", "));
    builder.append("]");
    return builder.toString();
  }

Member Data Documentation

EMPTY_ARRAY

final NavigationRegion [] org.dartlang.analysis.server.protocol.NavigationRegion.EMPTY_ARRAY = new NavigationRegion[0]

static

Definition at line 34 of file NavigationRegion.java.

EMPTY_LIST

final List<NavigationRegion> org.dartlang.analysis.server.protocol.NavigationRegion.EMPTY_LIST = Lists.newArrayList()

static

Definition at line 36 of file NavigationRegion.java.

---

The documentation for this class was generated from the following file:

• third_party/dart-lang/sdk/pkg/analysis_server/tool/spec/generated/java/types/NavigationRegion.java