li.cil.oc.api.driver

Interface Converter

public interface Converter

A converter is a callback that can be used to transparently convert Java types to something that can be pushed to a machine's architecture.

Note that converters operating on the same object type may override each other when using the same keys in the resulting Map. The order in which converters are called depends on the order they were registered in.

Method Summary

Methods

Modifier and Type	Method and Description
void	convert(java.lang.Object value, java.util.Map<java.lang.Object,java.lang.Object> output) Converts a type to a Map that only contains valid values, i.e.

Method Detail

convert

void convert(java.lang.Object value,
           java.util.Map<java.lang.Object,java.lang.Object> output)

Converts a type to a Map that only contains valid values, i.e. values that can be directly pushed to an architecture, without further conversion steps.

This is primarily enforced to avoid cycles in conversion steps. If the returned map contains any unsupported values, they will not be retained.

The conversion result should be placed into the the passed map, i.e. the map will represent the original object. For example, if the value had a field name, add a key name to the map with the value of that field.

Parameters:

value - the value to convert.

output - the map conversion results are accumulated into.