api

Interface IComponent

All Superinterfaces:

ISerializable, java.io.Serializable

All Known Subinterfaces:

IActiveComponent

All Known Implementing Classes:

Attack, Collision, Defense, Display, Drag, EventPath, Friction, GlobalForce, Gravity, Health, ImagePath, Lives, Mass, Orientation, Position, RendererProperties, RestitutionCoefficient, Score, SoundEffect, ThemeMusic, UserControl, Velocity, Visible

public interface IComponent
extends ISerializable

This is the interface for all components, which hold data.

Author:

Rhondu Smithwick, Tom Wu

Method Summary

Modifier and Type	Method and Description
default java.lang.Class<? extends IComponent>	getClassForComponentMap() Return the class to put into an entity map.
default java.util.List<javafx.beans.property.SimpleObjectProperty<?>>	getProperties() Gets any properties this component holds.
default <T> javafx.beans.property.SimpleObjectProperty<T>	getProperty(java.lang.Class<T> propertyClass, java.lang.String name) Gets a specific property with specified value class and with specified name.
default javafx.beans.property.SimpleObjectProperty<?>	getProperty(java.lang.String name) Get property with specified name.
default java.util.Map<java.lang.String,java.lang.Class<?>>	getPropertyNamesAndClasses() Get a map, where each entry is a component name to it's value class.
default void	removeBindings() Remove the bindings from all this Component's properties.

Methods inherited from interface api.ISerializable

clone, serialize, serializeToString

Method Detail

getProperties

default java.util.List<javafx.beans.property.SimpleObjectProperty<?>> getProperties()

Gets any properties this component holds.

Returns:

all the properties this component holds

getProperty

default javafx.beans.property.SimpleObjectProperty<?> getProperty(java.lang.String name)
                                                           throws java.lang.IllegalArgumentException

Get property with specified name.

Parameters:

name - of property to get

Returns:

the property

Throws:

java.lang.IllegalArgumentException - if no such property

getProperty

default <T> javafx.beans.property.SimpleObjectProperty<T> getProperty(java.lang.Class<T> propertyClass,
                                                                      java.lang.String name)
                                                               throws java.lang.IllegalArgumentException

Gets a specific property with specified value class and with specified name.

Example call for a position: SimpleObjectProperty$Double$ x = position.getProperty(Double, "X");

Type Parameters:

T - the type of the property's held value

Parameters:

propertyClass - the class of the property's held value

name - the name of property

Returns:

specific property of specified class and with name

Throws:

java.lang.IllegalArgumentException - if incorrect propertyClass or no property with this name is present

getPropertyNamesAndClasses

default java.util.Map<java.lang.String,java.lang.Class<?>> getPropertyNamesAndClasses()

Get a map, where each entry is a component name to it's value class.

Returns:

a map, where each entry is a component name to it's value class

getClassForComponentMap

default java.lang.Class<? extends IComponent> getClassForComponentMap()

Return the class to put into an entity map.

Returns:

the class to be put into an Entity map

removeBindings

default void removeBindings()

Remove the bindings from all this Component's properties.