Public Member Functions
	Outline (Outline parent, Element element, int offset, int length, int codeOffset, int codeLength)

boolean	containsInclusive (int x)

boolean	equals (Object obj)

Outline	getParent ()

List< Outline >	getChildren ()

int	getCodeLength ()

int	getCodeOffset ()

Element	getElement ()

int	getLength ()

int	getOffset ()

int	hashCode ()

void	setChildren (List< Outline > children)

void	setCodeLength (int codeLength)

void	setCodeOffset (int codeOffset)

void	setElement (Element element)

void	setLength (int length)

void	setOffset (int offset)

String	toString ()

Static Public Member Functions
static Outline	fromJson (Outline parent, JsonObject outlineObject)

Static Public Attributes
static final Outline[]	EMPTY_ARRAY = new Outline[0]

static final List< Outline >	EMPTY_LIST = Lists.newArrayList()

Detailed Description

An node in the outline structure of a file.

@coverage dart.server.generated.types

Definition at line 32 of file Outline.java.

Constructor & Destructor Documentation

◆ Outline()

org.dartlang.analysis.server.protocol.Outline.Outline	(	Outline	parent,
		Element	element,
		int	offset,
		int	length,
		int	codeOffset,
		int	codeLength
	)

inline

Constructor for Outline.

Definition at line 73 of file Outline.java.

                                                                                                          {
    this.parent = parent;
    this.element = element;
    this.offset = offset;
    this.length = length;
    this.codeOffset = codeOffset;
    this.codeLength = codeLength;
  }

Member Function Documentation

◆ containsInclusive()

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

inline

Definition at line 82 of file Outline.java.

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

◆ equals()

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

inline

Definition at line 87 of file Outline.java.

                                    {
    if (obj instanceof Outline) {
      Outline other = (Outline) obj;
      return
        ObjectUtilities.equals(other.element, element) &&
        other.offset == offset &&
        other.length == length &&
        other.codeOffset == codeOffset &&
        other.codeLength == codeLength &&
        ObjectUtilities.equals(other.children, children);
    }
    return false;
  }

◆ fromJson()

static Outline org.dartlang.analysis.server.protocol.Outline.fromJson	(	Outline	parent,
		JsonObject	outlineObject
	)

inlinestatic

Definition at line 101 of file Outline.java.

                                                                           {
    JsonObject elementObject = outlineObject.get("element").getAsJsonObject();
    Element element = Element.fromJson(elementObject);
    int offset = outlineObject.get("offset").getAsInt();
    int length = outlineObject.get("length").getAsInt();
    int codeOffset = outlineObject.get("codeOffset").getAsInt();
    int codeLength = outlineObject.get("codeLength").getAsInt();
 
    // create outline object
    Outline outline = new Outline(parent, element, offset, length, codeOffset, codeLength);
 
    // compute children recursively
    List<Outline> childrenList = Lists.newArrayList();
    JsonElement childrenJsonArray = outlineObject.get("children");
    if (childrenJsonArray instanceof JsonArray) {
      Iterator<JsonElement> childrenElementIterator = ((JsonArray) childrenJsonArray).iterator();
      while (childrenElementIterator.hasNext()) {
        JsonObject childObject = childrenElementIterator.next().getAsJsonObject();
        childrenList.add(fromJson(outline, childObject));
      }
    }
    outline.setChildren(childrenList);
    return outline;
  }

◆ getChildren()

List< Outline > org.dartlang.analysis.server.protocol.Outline.getChildren ( )

inline

The children of the node. The field will be omitted if the node has no children. Children are sorted by offset.

Definition at line 134 of file Outline.java.

                                     {
    return children;
  }

◆ getCodeLength()

int org.dartlang.analysis.server.protocol.Outline.getCodeLength ( )

inline

The length of the element code.

Definition at line 141 of file Outline.java.

                             {
    return codeLength;
  }

◆ getCodeOffset()

int org.dartlang.analysis.server.protocol.Outline.getCodeOffset ( )

inline

The offset of the first character of the element code, which is neither documentation, nor annotation.

Definition at line 149 of file Outline.java.

                             {
    return codeOffset;
  }

◆ getElement()

Element org.dartlang.analysis.server.protocol.Outline.getElement ( )

inline

A description of the element represented by this node.

Definition at line 156 of file Outline.java.

                              {
    return element;
  }

◆ getLength()

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

inline

The length of the element.

Definition at line 163 of file Outline.java.

                         {
    return length;
  }

◆ getOffset()

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

inline

The offset of the first character of the element. This is different than the offset in the Element, which is the offset of the name of the element. It can be used, for example, to map locations in the file back to an outline.

Definition at line 172 of file Outline.java.

                         {
    return offset;
  }

◆ getParent()

Outline org.dartlang.analysis.server.protocol.Outline.getParent ( )

inline

Definition at line 126 of file Outline.java.

                             {
    return parent;
  }

◆ hashCode()

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

inline

Definition at line 177 of file Outline.java.

                        {
    HashCodeBuilder builder = new HashCodeBuilder();
    builder.append(element);
    builder.append(offset);
    builder.append(length);
    builder.append(codeOffset);
    builder.append(codeLength);
    builder.append(children);
    return builder.toHashCode();
  }

◆ setChildren()

void org.dartlang.analysis.server.protocol.Outline.setChildren ( List< Outline > children )

inline

The children of the node. The field will be omitted if the node has no children. Children are sorted by offset.

Definition at line 192 of file Outline.java.

                                                  {
    this.children = children;
  }

◆ setCodeLength()

void org.dartlang.analysis.server.protocol.Outline.setCodeLength ( int codeLength )

inline

The length of the element code.

Definition at line 199 of file Outline.java.

                                            {
    this.codeLength = codeLength;
  }

◆ setCodeOffset()

void org.dartlang.analysis.server.protocol.Outline.setCodeOffset ( int codeOffset )

inline

The offset of the first character of the element code, which is neither documentation, nor annotation.

Definition at line 207 of file Outline.java.

                                            {
    this.codeOffset = codeOffset;
  }

◆ setElement()

void org.dartlang.analysis.server.protocol.Outline.setElement ( Element element )

inline

A description of the element represented by this node.

Definition at line 214 of file Outline.java.

                                          {
    this.element = element;
  }

◆ setLength()

void org.dartlang.analysis.server.protocol.Outline.setLength ( int length )

inline

The length of the element.

Definition at line 221 of file Outline.java.

                                    {
    this.length = length;
  }

◆ setOffset()

void org.dartlang.analysis.server.protocol.Outline.setOffset ( int offset )

inline

The offset of the first character of the element. This is different than the offset in the Element, which is the offset of the name of the element. It can be used, for example, to map locations in the file back to an outline.

Definition at line 230 of file Outline.java.

                                    {
    this.offset = offset;
  }

◆ toString()

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

inline

Definition at line 235 of file Outline.java.

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

Member Data Documentation

◆ EMPTY_ARRAY

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

static

Definition at line 34 of file Outline.java.

◆ EMPTY_LIST

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

static

Definition at line 36 of file Outline.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/Outline.java

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Outline()

Member Function Documentation

◆ containsInclusive()

◆ equals()

◆ fromJson()

◆ getChildren()

◆ getCodeLength()

◆ getCodeOffset()

◆ getElement()

◆ getLength()

◆ getOffset()

◆ getParent()

◆ hashCode()

◆ setChildren()

◆ setCodeLength()

◆ setCodeOffset()

◆ setElement()

◆ setLength()

◆ setOffset()

◆ toString()

Member Data Documentation

◆ EMPTY_ARRAY

◆ EMPTY_LIST