flex.messaging.io.amf.ActionMessageInput Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package flex.messaging.io.amf;
import java.io.IOException;
import java.io.InputStream;
import java.io.ObjectInput;
/**
* This simple interface allows the MessageDeserializer to
* handle multiple versions of AMF.
*
* Entry point for deserializing an individual ActionMessage
* request message for AMF, AMFX or RTMP.
*
* @see flex.messaging.io.amf.Amf0Input Classic Version 0 Deserializer
* @see flex.messaging.io.amf.Amf3Input AVM+ Version 3 Deserializer
*
* @see flex.messaging.io.amf.ActionMessageOutput The serialization equivalent
*/
public interface ActionMessageInput extends ObjectInput
{
// java.io.ObjectInput METHODS
/**
* Reads in an AMF formatted Object.
*
*
* The following is a guide to the ActionScript to Java type mappings:
*
* ActionScript Type (AMF 3) Java Type
* String java.lang.String
* Boolean java.lang.Boolean
* int
uint java.lang.Integer
* Number java.lang.Double
* Date java.util.Date
* ByteArray java.util.Byte.TYPE[]
* mx.collections.ArrayCollection flex.messaging.io.ArrayCollection
* Array java.lang.Object[] (Native Array)
* Object java.util.Map
* flash.utils.IExternalizable java.io.Externalizable
* Typed Object (other than the above) An instance of type Class (java.lang.Object)
* null null
*
*
*
*
*
* ActionScript Type (AMF 0) Java Type
* String java.lang.String
* Boolean java.lang.Boolean
* int
uint java.lang.Double
* Number java.lang.Double
* Date java.util.Date
* ByteArray (Not supported)
* mx.collections.ArrayCollection flex.messaging.io.ArrayCollection
* Array java.lang.Object[] (Native Array)
* Object java.util.Map
* flash.utils.IExternalizable (Not supported)
* Typed Object (other than the above) An instance of type Class (java.lang.Object)
* null null
*
*
*/
Object readObject() throws ClassNotFoundException, IOException;
//
// INITIALIZATION UTILITIES
//
/**
* Internal use only.
*
*/
void setInputStream(InputStream in);
/**
* Internal use only.
*
*/
void setDebugTrace(AmfTrace trace);
/**
* Internal use only.
*
*/
void reset();
}