Class ComponentChild

    • Method Detail

      • componentType

        public final String componentType()

        The type of the child component.

        Returns:
        The type of the child component.
      • name

        public final String name()

        The name of the child component.

        Returns:
        The name of the child component.
      • hasProperties

        public final boolean hasProperties()
        For responses, this returns true if the service returned a value for the Properties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • properties

        public final Map<String,​ComponentProperty> properties()

        Describes the properties of the child component. You can't specify tags as a valid property for properties.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProperties() method.

        Returns:
        Describes the properties of the child component. You can't specify tags as a valid property for properties.
      • hasChildren

        public final boolean hasChildren()
        For responses, this returns true if the service returned a value for the Children property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • children

        public final List<ComponentChild> children()

        The list of ComponentChild instances for this component.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasChildren() method.

        Returns:
        The list of ComponentChild instances for this component.
      • hasEvents

        public final boolean hasEvents()
        For responses, this returns true if the service returned a value for the Events property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • events

        public final Map<String,​ComponentEvent> events()

        Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEvents() method.

        Returns:
        Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
      • sourceId

        public final String sourceId()

        The unique ID of the child component in its original source system, such as Figma.

        Returns:
        The unique ID of the child component in its original source system, such as Figma.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)