]>
Commit | Line | Data |
---|---|---|
f67539c2 TL |
1 | /* |
2 | * Licensed to the Apache Software Foundation (ASF) under one | |
3 | * or more contributor license agreements. See the NOTICE file | |
4 | * distributed with this work for additional information | |
5 | * regarding copyright ownership. The ASF licenses this file | |
6 | * to you under the Apache License, Version 2.0 (the | |
7 | * "License"); you may not use this file except in compliance | |
8 | * with the License. You may obtain a copy of the License at | |
9 | * | |
10 | * http://www.apache.org/licenses/LICENSE-2.0 | |
11 | * | |
12 | * Unless required by applicable law or agreed to in writing, | |
13 | * software distributed under the License is distributed on an | |
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
15 | * KIND, either express or implied. See the License for the | |
16 | * specific language governing permissions and limitations | |
17 | * under the License. | |
18 | */ | |
19 | ||
20 | package org.apache.thrift { | |
21 | ||
22 | import org.apache.thrift.protocol.TProtocol; | |
23 | ||
24 | /** | |
25 | * Generic base interface for generated Thrift objects. | |
26 | * | |
27 | */ | |
28 | public interface TBase { | |
29 | ||
30 | /** | |
31 | * Reads the TObject from the given input protocol. | |
32 | * | |
33 | * @param iprot Input protocol | |
34 | */ | |
35 | function read(iprot:TProtocol):void; | |
36 | ||
37 | /** | |
38 | * Writes the objects out to the protocol | |
39 | * | |
40 | * @param oprot Output protocol | |
41 | */ | |
42 | function write(oprot:TProtocol):void; | |
43 | ||
44 | /** | |
45 | * Check if a field is currently set or unset. | |
46 | * | |
47 | * @param fieldId The field's id tag as found in the IDL. | |
48 | */ | |
49 | function isSet(fieldId:int):Boolean; | |
50 | ||
51 | /** | |
52 | * Get a field's value by id. Primitive types will be wrapped in the | |
53 | * appropriate "boxed" types. | |
54 | * | |
55 | * @param fieldId The field's id tag as found in the IDL. | |
56 | */ | |
57 | function getFieldValue(fieldId:int):*; | |
58 | ||
59 | /** | |
60 | * Set a field's value by id. Primitive types must be "boxed" in the | |
61 | * appropriate object wrapper type. | |
62 | * | |
63 | * @param fieldId The field's id tag as found in the IDL. | |
64 | */ | |
65 | function setFieldValue(fieldId:int, value:*):void; | |
66 | } | |
67 | } |