org.eclipse.smila.scripting.internal

Class AttachmentWrapper

java.lang.Object

org.eclipse.smila.scripting.internal.ObjectWrapperBase

org.eclipse.smila.scripting.internal.AttachmentWrapper

public class AttachmentWrapper
extends ObjectWrapperBase

Provides access to Record attachments as a native Javascript object.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.nio.charset.Charset	STRING_AS_ATTACHMENT_CHARSET

Constructor Summary

Constructors

Constructor and Description
AttachmentWrapper(Record record, Scriptable parentScope) Creates wrapper instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(int index)
void	delete(java.lang.String name)
java.lang.Object	get(int index, Scriptable start)
java.lang.Object	get(java.lang.String name, Scriptable start)
java.lang.String	getClassName()
java.lang.Object	getDefaultValue(java.lang.Class<?> hint)
java.lang.Object[]	getIds()
boolean	has(int index, Scriptable start)
boolean	has(java.lang.String name, Scriptable start)
void	put(int index, Scriptable start, java.lang.Object value)
void	put(java.lang.String name, Scriptable start, java.lang.Object value) Supported value types are: byte[]: is used as the attachment value immediately.
Record	unwrap()

Methods inherited from class org.eclipse.smila.scripting.internal.ObjectWrapperBase

getParentScope, getPrototype, hasInstance, setParentScope, setPrototype

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STRING_AS_ATTACHMENT_CHARSET

protected static final java.nio.charset.Charset STRING_AS_ATTACHMENT_CHARSET

Constructor Detail

AttachmentWrapper

public AttachmentWrapper(Record record,
                 Scriptable parentScope)

Creates wrapper instance.

Method Detail

unwrap

public Record unwrap()

getClassName

public java.lang.String getClassName()

get

public java.lang.Object get(java.lang.String name,
                   Scriptable start)

Returns:

attachment from contained record as Attachment.

get

public java.lang.Object get(int index,
                   Scriptable start)

has

public boolean has(java.lang.String name,
          Scriptable start)

has

public boolean has(int index,
          Scriptable start)

put

public void put(java.lang.String name,
       Scriptable start,
       java.lang.Object value)

Supported value types are:

• byte[]
: is used as the attachment value immediately.
• CharSequence
: is converted to a String and then to a byte[] using UTF-8 charset.
• Attachment
: if the name of the attachment matches the given name, the attachment object is added to the wrapped record itself. Else the method tries to get the attachment content as a byte[] and adds it to the wrapped record. If the given attachment does not return the attachment content as byte[], an EvaluatorException will be thrown.
• InputStream
: The method tries to read the stream into an byte[] and sets this as the attachment. If reading fails, an EvaluatorException will be thrown. The given stream is closed afterwards in any case.

The value can also be a Wrapper. In this case unwrapping must produce one of the above types.

Parameters:

value - an object to create an attachment value from.

put

public void put(int index,
       Scriptable start,
       java.lang.Object value)

delete

public void delete(java.lang.String name)

delete

public void delete(int index)

getIds

public java.lang.Object[] getIds()

getDefaultValue

public java.lang.Object getDefaultValue(java.lang.Class<?> hint)

Overrides:

getDefaultValue in class ObjectWrapperBase