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

Public Member Functions
	FlutterWidgetProperty (String documentation, String expression, int id, boolean isRequired, boolean isSafeToUpdate, String name, List< FlutterWidgetProperty > children, FlutterWidgetPropertyEditor editor, FlutterWidgetPropertyValue value)
boolean	equals (Object obj)
List< FlutterWidgetProperty >	getChildren ()
String	getDocumentation ()
FlutterWidgetPropertyEditor	getEditor ()
String	getExpression ()
int	getId ()
boolean	isRequired ()
boolean	isSafeToUpdate ()
String	getName ()
FlutterWidgetPropertyValue	getValue ()
int	hashCode ()
JsonObject	toJson ()
String	toString ()

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

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

Detailed Description

A property of a Flutter widget.

@coverage dart.server.generated.types

Definition at line 32 of file FlutterWidgetProperty.java.

Constructor & Destructor Documentation

FlutterWidgetProperty()

org.dartlang.analysis.server.protocol.FlutterWidgetProperty.FlutterWidgetProperty ( String  documentation, String  expression, int  id, boolean  isRequired, boolean  isSafeToUpdate, String  name, List< FlutterWidgetProperty >  children, FlutterWidgetPropertyEditor  editor, FlutterWidgetPropertyValue  value  )

inline

Constructor for FlutterWidgetProperty.

Definition at line 94 of file FlutterWidgetProperty.java.

                                                                                                                                                                                                                                                     {
    this.documentation = documentation;
    this.expression = expression;
    this.id = id;
    this.isRequired = isRequired;
    this.isSafeToUpdate = isSafeToUpdate;
    this.name = name;
    this.children = children;
    this.editor = editor;
    this.value = value;
  }

Member Function Documentation

equals()

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

inline

Definition at line 107 of file FlutterWidgetProperty.java.

                                    {
    if (obj instanceof FlutterWidgetProperty) {
      FlutterWidgetProperty other = (FlutterWidgetProperty) obj;
      return
        ObjectUtilities.equals(other.documentation, documentation) &&
        ObjectUtilities.equals(other.expression, expression) &&
        other.id == id &&
        other.isRequired == isRequired &&
        other.isSafeToUpdate == isSafeToUpdate &&
        ObjectUtilities.equals(other.name, name) &&
        ObjectUtilities.equals(other.children, children) &&
        ObjectUtilities.equals(other.editor, editor) &&
        ObjectUtilities.equals(other.value, value);
    }
    return false;
  }

fromJson()

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

inlinestatic

Definition at line 124 of file FlutterWidgetProperty.java.

                                                                      {
    String documentation = jsonObject.get("documentation") == null ? null : jsonObject.get("documentation").getAsString();
    String expression = jsonObject.get("expression") == null ? null : jsonObject.get("expression").getAsString();
    int id = jsonObject.get("id").getAsInt();
    boolean isRequired = jsonObject.get("isRequired").getAsBoolean();
    boolean isSafeToUpdate = jsonObject.get("isSafeToUpdate").getAsBoolean();
    String name = jsonObject.get("name").getAsString();
    List<FlutterWidgetProperty> children = jsonObject.get("children") == null ? null : FlutterWidgetProperty.fromJsonArray(jsonObject.get("children").getAsJsonArray());
    FlutterWidgetPropertyEditor editor = jsonObject.get("editor") == null ? null : FlutterWidgetPropertyEditor.fromJson(jsonObject.get("editor").getAsJsonObject());
    FlutterWidgetPropertyValue value = jsonObject.get("value") == null ? null : FlutterWidgetPropertyValue.fromJson(jsonObject.get("value").getAsJsonObject());
    return new FlutterWidgetProperty(documentation, expression, id, isRequired, isSafeToUpdate, name, children, editor, value);
  }

fromJsonArray()

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

inlinestatic

Definition at line 137 of file FlutterWidgetProperty.java.

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

getChildren()

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

inline

The list of children properties, if any. For example any property of type EdgeInsets will have four children properties of type double - left / top / right / bottom.

Definition at line 153 of file FlutterWidgetProperty.java.

                                                   {
    return children;
  }

getDocumentation()

String org.dartlang.analysis.server.protocol.FlutterWidgetProperty.getDocumentation ( )

inline

The documentation of the property to show to the user. Omitted if the server does not know the documentation, e.g. because the corresponding field is not documented.

Definition at line 161 of file FlutterWidgetProperty.java.

                                   {
    return documentation;
  }

getEditor()

FlutterWidgetPropertyEditor org.dartlang.analysis.server.protocol.FlutterWidgetProperty.getEditor ( )

inline

The editor that should be used by the client. This field is omitted if the server does not know the editor for this property, for example because it does not have one of the supported types.

Definition at line 169 of file FlutterWidgetProperty.java.

                                                 {
    return editor;
  }

getExpression()

String org.dartlang.analysis.server.protocol.FlutterWidgetProperty.getExpression ( )

inline

If the value of this property is set, the Dart code of the expression of this property.

Definition at line 176 of file FlutterWidgetProperty.java.

                                {
    return expression;
  }

getId()

int org.dartlang.analysis.server.protocol.FlutterWidgetProperty.getId ( )

inline

The unique identifier of the property, must be passed back to the server when updating the property value. Identifiers become invalid on any source code change.

Definition at line 184 of file FlutterWidgetProperty.java.

                     {
    return id;
  }

getName()

String org.dartlang.analysis.server.protocol.FlutterWidgetProperty.getName ( )

inline

The name of the property to display to the user.

Definition at line 209 of file FlutterWidgetProperty.java.

                          {
    return name;
  }

getValue()

FlutterWidgetPropertyValue org.dartlang.analysis.server.protocol.FlutterWidgetProperty.getValue ( )

inline

If the expression is set, and the server knows the value of the expression, this field is set.

Definition at line 216 of file FlutterWidgetProperty.java.

                                               {
    return value;
  }

hashCode()

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

inline

Definition at line 221 of file FlutterWidgetProperty.java.

                        {
    HashCodeBuilder builder = new HashCodeBuilder();
    builder.append(documentation);
    builder.append(expression);
    builder.append(id);
    builder.append(isRequired);
    builder.append(isSafeToUpdate);
    builder.append(name);
    builder.append(children);
    builder.append(editor);
    builder.append(value);
    return builder.toHashCode();
  }

isRequired()

boolean org.dartlang.analysis.server.protocol.FlutterWidgetProperty.isRequired ( )

inline

True if the property is required, e.g. because it corresponds to a required parameter of a constructor.

Definition at line 192 of file FlutterWidgetProperty.java.

                              {
    return isRequired;
  }

isSafeToUpdate()

boolean org.dartlang.analysis.server.protocol.FlutterWidgetProperty.isSafeToUpdate ( )

inline

If the property expression is a concrete value (e.g. a literal, or an enum constant), then it is safe to replace the expression with another concrete value. In this case this field is true. Otherwise, for example when the expression is a reference to a field, so that its value is provided from outside, this field is false.

Definition at line 202 of file FlutterWidgetProperty.java.

                                  {
    return isSafeToUpdate;
  }

toJson()

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

inline

Definition at line 235 of file FlutterWidgetProperty.java.

                             {
    JsonObject jsonObject = new JsonObject();
    if (documentation != null) {
      jsonObject.addProperty("documentation", documentation);
    }
    if (expression != null) {
      jsonObject.addProperty("expression", expression);
    }
    jsonObject.addProperty("id", id);
    jsonObject.addProperty("isRequired", isRequired);
    jsonObject.addProperty("isSafeToUpdate", isSafeToUpdate);
    jsonObject.addProperty("name", name);
    if (children != null) {
      JsonArray jsonArrayChildren = new JsonArray();
      for (FlutterWidgetProperty elt : children) {
        jsonArrayChildren.add(elt.toJson());
      }
      jsonObject.add("children", jsonArrayChildren);
    }
    if (editor != null) {
      jsonObject.add("editor", editor.toJson());
    }
    if (value != null) {
      jsonObject.add("value", value.toJson());
    }
    return jsonObject;
  }

toString()

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

inline

Definition at line 264 of file FlutterWidgetProperty.java.

                           {
    StringBuilder builder = new StringBuilder();
    builder.append("[");
    builder.append("documentation=");
    builder.append(documentation + ", ");
    builder.append("expression=");
    builder.append(expression + ", ");
    builder.append("id=");
    builder.append(id + ", ");
    builder.append("isRequired=");
    builder.append(isRequired + ", ");
    builder.append("isSafeToUpdate=");
    builder.append(isSafeToUpdate + ", ");
    builder.append("name=");
    builder.append(name + ", ");
    builder.append("children=");
    builder.append(StringUtils.join(children, ", ") + ", ");
    builder.append("editor=");
    builder.append(editor + ", ");
    builder.append("value=");
    builder.append(value);
    builder.append("]");
    return builder.toString();
  }

Member Data Documentation

EMPTY_ARRAY

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

static

Definition at line 34 of file FlutterWidgetProperty.java.

EMPTY_LIST

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

static

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