gnu.CORBA.typecodes

Class GeneralTypeCode

Implemented Interfaces:
IDLEntity, Serializable
Known Direct Subclasses:
RecordTypeCode

public class GeneralTypeCode
extends PrimitiveTypeCode

A typecode for types, requiring to provide various additional properties but still not requiring to store the members of the structure. The property can be retrieved by the corresponding method if it has been previously assigned. Otherwise, a BadKind is thrown.
See Also:
Serialized Form

Field Summary

protected static int
UNSET
Indicates that the field value has not been previously set.

Fields inherited from class gnu.CORBA.typecodes.PrimitiveTypeCode

kind

Constructor Summary

GeneralTypeCode(TCKind a_kind)
Create a new instance, setting kind to the given kind.

Method Summary

TypeCode
concrete_base_type()
TypeCode
content_type()
Returns the content type that must be explicitly set for this class.
boolean
equal(TypeCode other)
Returns true if both typecodes, if written into CDR stream, would result the same stream content.
boolean
equivalent(TypeCode other)
Delegates functionality to equal(TypeCode).
String
id()
int
length()
Get the length.
String
name()
void
setConcreteBase_type(TypeCode a_concrete_base_type)
Set this property.
void
setContentType(TypeCode a_content_type)
Set the component content type.
void
setId(String an_id)
Set this property.
void
setLength(int l)
Set the length property.
void
setName(String a_name)
Set this property.
void
setTypeModifier(int a_type_modifier)
Set the type modifier.
short
type_modifier()

Methods inherited from class gnu.CORBA.typecodes.PrimitiveTypeCode

concrete_base_type, content_type, default_index, discriminator_type, equal, equivalent, fixed_digits, fixed_scale, get_compact_typecode, id, kind, length, member_count, member_label, member_name, member_type, member_visibility, name, type_modifier

Methods inherited from class org.omg.CORBA.TypeCode

concrete_base_type, content_type, default_index, discriminator_type, equal, equivalent, fixed_digits, fixed_scale, get_compact_typecode, id, kind, length, member_count, member_label, member_name, member_type, member_visibility, name, type_modifier

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

UNSET

protected static int UNSET
Indicates that the field value has not been previously set.

Constructor Details

GeneralTypeCode

public GeneralTypeCode(TCKind a_kind)
Create a new instance, setting kind to the given kind.
Parameters:
a_kind - the kind of the typecode being created.

Method Details

concrete_base_type

public TypeCode concrete_base_type()
            throws BadKind
Overrides:
concrete_base_type in interface PrimitiveTypeCode

content_type

public TypeCode content_type()
            throws BadKind
Returns the content type that must be explicitly set for this class.
Overrides:
content_type in interface PrimitiveTypeCode
Throws:
BadKind - if the content type has not been set.

equal

public boolean equal(TypeCode other)
Returns true if both typecodes, if written into CDR stream, would result the same stream content.
Overrides:
equal in interface PrimitiveTypeCode

equivalent

public boolean equivalent(TypeCode other)
Delegates functionality to equal(TypeCode).
Overrides:
equivalent in interface PrimitiveTypeCode

id

public String id()
            throws BadKind
Overrides:
id in interface PrimitiveTypeCode

length

public int length()
            throws BadKind
Get the length. For sequences, arrays, strings and wstrings this method returns 0 rather than throwing a BadKind even if setLength(int) has not been previously called.
Overrides:
length in interface PrimitiveTypeCode
Returns:
the length of string, array or sequence.
Throws:
BadKind - if the method cannot be invoked for the given kind of typecode.

name

public String name()
            throws BadKind
Overrides:
name in interface PrimitiveTypeCode

setConcreteBase_type

public void setConcreteBase_type(TypeCode a_concrete_base_type)
Set this property.

setContentType

public void setContentType(TypeCode a_content_type)
Set the component content type.

setId

public void setId(String an_id)
Set this property.

setLength

public void setLength(int l)
Set the length property.
Parameters:
l -

setName

public void setName(String a_name)
Set this property.

setTypeModifier

public void setTypeModifier(int a_type_modifier)
Set the type modifier.

type_modifier

public short type_modifier()
            throws BadKind
Overrides:
type_modifier in interface PrimitiveTypeCode

GeneralTypeCode.java -- Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.