org.omg.CORBA
Class _ContainerStub

java.lang.Object
  |
  +--org.omg.CORBA.portable.ObjectImpl
        |
        +--org.omg.CORBA._ContainerStub
All Implemented Interfaces:
Container, ContainerOperations, IDLEntity, IRObject, IRObjectOperations, Object, java.io.Serializable

public class _ContainerStub
extends ObjectImpl
implements Container

The base interface Container is used to form a containment hierarchy in the Interface Repository. A Container can contain any number of objects derived from the Contained interface. All Containers, except for Repository, are also derived from Contained.

See Also:
Serialized Form

Constructor Summary
_ContainerStub()
           
 
Method Summary
 java.lang.String[] _ids()
           
 Contained[] contents(DefinitionKind limit_type, boolean exclude_inherited)
          The contents operation returns the list of objects directly contained by or inherited into the object.
 AbstractInterfaceDef create_abstract_interface(java.lang.String id, java.lang.String name, java.lang.String version, AbstractInterfaceDef[] base_interfaces)
          The create_abstract_interface operation returns a new AbstractInterfaceDef with the specified name and base interfaces.
 AliasDef create_alias(java.lang.String id, java.lang.String name, java.lang.String version, IDLType original_type)
          The create_alias operation returns a new AliasDef with the specified original_type.
 ConstantDef create_constant(java.lang.String id, java.lang.String name, java.lang.String version, IDLType type, Any value)
          The create_constant operation returns a new ConstantDef with the specified type and value.
 EnumDef create_enum(java.lang.String id, java.lang.String name, java.lang.String version, java.lang.String[] members)
          The create_enum operation returns a new EnumDef with the specified members.
 ExceptionDef create_exception(java.lang.String id, java.lang.String name, java.lang.String version, StructMember[] members)
          The create_exception operation returns a new ExceptionDef with the specified members.
 InterfaceDef create_interface(java.lang.String id, java.lang.String name, java.lang.String version, InterfaceDef[] base_interfaces)
          The create_interface operation returns a new empty InterfaceDef with the specified base_interfaces.
 LocalInterfaceDef create_local_interface(java.lang.String id, java.lang.String name, java.lang.String version, LocalInterfaceDef[] base_interfaces)
          The create_local_interface operation returns a new LocalInterfaceDef with the specified name and base interfaces.
 ModuleDef create_module(java.lang.String id, java.lang.String name, java.lang.String version)
          The create_module operation returns a new empty ModuleDef.
 NativeDef create_native(java.lang.String id, java.lang.String name, java.lang.String version)
          The create_native operation returns a new NativeDef with the specified name.
 StructDef create_struct(java.lang.String id, java.lang.String name, java.lang.String version, StructMember[] members)
          The create_struct operation returns a new StructDef with the specified members.
 UnionDef create_union(java.lang.String id, java.lang.String name, java.lang.String version, IDLType discriminator_type, UnionMember[] members)
          The create_union operation returns a new UnionDef with the specified discriminator_type and members.
 ValueBoxDef create_value_box(java.lang.String id, java.lang.String name, java.lang.String version, IDLType original_type_def)
          The create_value_box operation returns a new ValueBoxDef with the specified original_type_def.
 ValueDef create_value(java.lang.String id, java.lang.String name, java.lang.String version, boolean is_custom, boolean is_abstract, ValueDef base_value, boolean is_truncatable, ValueDef[] abstract_base_value, InterfaceDef[] supported_interfaces, Initializer[] initializers)
          The create_value operation returns a new empty ValueDef with the specified base interfaces and values (base_value, supported_interfaces, and abstract_base_values) as well as the other information describing the new values characteristics (is_custom, is_abstract, is_truncatable, and initializers).
 DefinitionKind def_kind()
          The def_kind type_name attribute identifies the type of the definition.
 Description[] describe_contents(DefinitionKind limit_type, boolean exclude_inherited, int max_returned_objs)
          The describe_contents operation combines the contents operation and the describe operation.
 void destroy()
          The destroy operation causes the object to cease to exist.
 Contained[] lookup_name(java.lang.String search_name, int levels_to_search, DefinitionKind limit_type, boolean exclude_inherited)
          The lookup_name operation is used to locate an object by name within a particular object or within the objects contained by that object.
 Contained lookup(java.lang.String search_name)
          The lookup operation locates a definition relative to this container given a scoped name using OMG IDL’s name scoping rules.
 
Methods inherited from class org.omg.CORBA.portable.ObjectImpl
_create_request, _create_request, _duplicate, _get_delegate, _get_domain_managers, _get_interface_def, _get_interface, _get_policy, _hash, _invoke, _is_a, _is_equivalent, _is_local, _non_existent, _orb, _release, _releaseReply, _request, _request, _servant_postinvoke, _servant_preinvoke, _set_delegate, _set_policy_override, equals, hashCode, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.omg.CORBA.Object
_create_request, _create_request, _duplicate, _get_domain_managers, _get_interface_def, _get_interface, _get_policy, _hash, _is_a, _is_equivalent, _non_existent, _release, _request, _set_policy_override
 

Constructor Detail

_ContainerStub

public _ContainerStub()
Method Detail

_ids

public java.lang.String[] _ids()
Overrides:
_ids in class ObjectImpl

lookup

public Contained lookup(java.lang.String search_name)
Description copied from interface: ContainerOperations
The lookup operation locates a definition relative to this container given a scoped name using OMG IDL’s name scoping rules. An absolute scoped name (beginning with "::") locates the definition relative to the enclosing Repository. If no object is found, a nil object reference is returned.
Specified by:
lookup in interface ContainerOperations

contents

public Contained[] contents(DefinitionKind limit_type,
                            boolean exclude_inherited)
Description copied from interface: ContainerOperations
The contents operation returns the list of objects directly contained by or inherited into the object. The operation is used to navigate through the hierarchy of objects. Starting with the Repository object, a client uses this operation to list all of the objects contained by the Repository, all of the objects contained by the modules within the Repository, and then all of the interfaces and value types within a specific module, and so on.
Specified by:
contents in interface ContainerOperations
Following copied from interface: org.omg.CORBA.ContainerOperations
Parameters:
limit_type - If limit_type is set to dk_all "all", objects of all interface types are returned. For example, if this is an InterfaceDef, the attribute, operation, and exception objects are all returned. If limit_type is set to a specific interface, only objects of that interface type are returned. For example, only attribute objects are returned if limit_type is set to dk_Attribute "AttributeDef".
exclude_inherited - If set to TRUE, inherited objects (if there are any) are not returned. If set to FALSE, all contained objects,whether contained due to inheritance or because they were defined within the object,are returned.

lookup_name

public Contained[] lookup_name(java.lang.String search_name,
                               int levels_to_search,
                               DefinitionKind limit_type,
                               boolean exclude_inherited)
Description copied from interface: ContainerOperations
The lookup_name operation is used to locate an object by name within a particular object or within the objects contained by that object. Use of values of levels_to_search of 0 or of negative numbers other than -1 is undefined.
Specified by:
lookup_name in interface ContainerOperations
Following copied from interface: org.omg.CORBA.ContainerOperations
Parameters:
search_name - Specified which name is to be searched for.
levels_to_search - Controls whether the lookup is constrained to the object the operation is invoked on or whether it should search through objects contained by the object as well.
limit_type - If limit_type is set to dk_all "all", objects of all interface types are returned. For example, if this is an InterfaceDef, the attribute, operation, and exception objects are all returned. If limit_type is set to a specific interface, only objects of that interface type are returned. For example, only attribute objects are returned if limit_type is set to dk_Attribute "AttributeDef".
exclude_inherited - If set to TRUE, inherited objects (if there are any) are not returned. If set to FALSE, all contained objects,whether contained due to inheritance or because they were defined within the object,are returned.

describe_contents

public Description[] describe_contents(DefinitionKind limit_type,
                                       boolean exclude_inherited,
                                       int max_returned_objs)
Description copied from interface: ContainerOperations
The describe_contents operation combines the contents operation and the describe operation. For each object returned by the contents operation, the description of the object is returned (i.e., the object’s describe operation is invoked and the results returned).
Specified by:
describe_contents in interface ContainerOperations
Following copied from interface: org.omg.CORBA.ContainerOperations
Parameters:
limit_type - If limit_type is set to dk_all "all", objects of all interface types are returned. For example, if this is an InterfaceDef, the attribute, operation, and exception objects are all returned. If limit_type is set to a specific interface, only objects of that interface type are returned. For example, only attribute objects are returned if limit_type is set to dk_Attribute "AttributeDef".
exclude_inherited - If set to TRUE, inherited objects (if there are any) are not returned. If set to FALSE, all contained objects,whether contained due to inheritance or because they were defined within the object,are returned.
max_returned_objs - max_returned_objs Limits the number of objects that can be returned in an invocation of the call to the number provided. Setting the parameter to -1 means return all contained objects.

create_module

public ModuleDef create_module(java.lang.String id,
                               java.lang.String name,
                               java.lang.String version)
Description copied from interface: ContainerOperations
The create_module operation returns a new empty ModuleDef. Definitions can be added using Container::create_ operations on the new module, or by using the Contained::move operation.
Specified by:
create_module in interface ContainerOperations

create_constant

public ConstantDef create_constant(java.lang.String id,
                                   java.lang.String name,
                                   java.lang.String version,
                                   IDLType type,
                                   Any value)
Description copied from interface: ContainerOperations
The create_constant operation returns a new ConstantDef with the specified type and value.
Specified by:
create_constant in interface ContainerOperations

create_struct

public StructDef create_struct(java.lang.String id,
                               java.lang.String name,
                               java.lang.String version,
                               StructMember[] members)
Description copied from interface: ContainerOperations
The create_struct operation returns a new StructDef with the specified members. The type member of the StructMember structures is ignored, and should be set to TC_void.
Specified by:
create_struct in interface ContainerOperations

create_union

public UnionDef create_union(java.lang.String id,
                             java.lang.String name,
                             java.lang.String version,
                             IDLType discriminator_type,
                             UnionMember[] members)
Description copied from interface: ContainerOperations
The create_union operation returns a new UnionDef with the specified discriminator_type and members. The type member of the UnionMember structures is ignored, and should be set to TC_void.
Specified by:
create_union in interface ContainerOperations

create_enum

public EnumDef create_enum(java.lang.String id,
                           java.lang.String name,
                           java.lang.String version,
                           java.lang.String[] members)
Description copied from interface: ContainerOperations
The create_enum operation returns a new EnumDef with the specified members.
Specified by:
create_enum in interface ContainerOperations

create_alias

public AliasDef create_alias(java.lang.String id,
                             java.lang.String name,
                             java.lang.String version,
                             IDLType original_type)
Description copied from interface: ContainerOperations
The create_alias operation returns a new AliasDef with the specified original_type.
Specified by:
create_alias in interface ContainerOperations

create_interface

public InterfaceDef create_interface(java.lang.String id,
                                     java.lang.String name,
                                     java.lang.String version,
                                     InterfaceDef[] base_interfaces)
Description copied from interface: ContainerOperations
The create_interface operation returns a new empty InterfaceDef with the specified base_interfaces. Type, exception, and constant definitions can be added using Container::create_ operations on the new InterfaceDef. OperationDefs can be added using InterfaceDef::create_operation and AttributeDefs can be added using Interface::create_attribute. Definitions can also be added using the Contained::move operation.
Specified by:
create_interface in interface ContainerOperations

create_value

public ValueDef create_value(java.lang.String id,
                             java.lang.String name,
                             java.lang.String version,
                             boolean is_custom,
                             boolean is_abstract,
                             ValueDef base_value,
                             boolean is_truncatable,
                             ValueDef[] abstract_base_value,
                             InterfaceDef[] supported_interfaces,
                             Initializer[] initializers)
Description copied from interface: ContainerOperations
The create_value operation returns a new empty ValueDef with the specified base interfaces and values (base_value, supported_interfaces, and abstract_base_values) as well as the other information describing the new values characteristics (is_custom, is_abstract, is_truncatable, and initializers). Type, exception, and constant definitions can be added using Container::create_ operations on the new ValueDef. OperationDefs can be added using ValueDef::create_operation and AttributeDefs can be added using Value::create_attribute. Definitions can also be added using the Contained::move operation.
Specified by:
create_value in interface ContainerOperations

create_value_box

public ValueBoxDef create_value_box(java.lang.String id,
                                    java.lang.String name,
                                    java.lang.String version,
                                    IDLType original_type_def)
Description copied from interface: ContainerOperations
The create_value_box operation returns a new ValueBoxDef with the specified original_type_def.
Specified by:
create_value_box in interface ContainerOperations

create_exception

public ExceptionDef create_exception(java.lang.String id,
                                     java.lang.String name,
                                     java.lang.String version,
                                     StructMember[] members)
Description copied from interface: ContainerOperations
The create_exception operation returns a new ExceptionDef with the specified members. The type member of the StructMember structures should be set to TC_void.
Specified by:
create_exception in interface ContainerOperations

create_native

public NativeDef create_native(java.lang.String id,
                               java.lang.String name,
                               java.lang.String version)
Description copied from interface: ContainerOperations
The create_native operation returns a new NativeDef with the specified name.
Specified by:
create_native in interface ContainerOperations

create_abstract_interface

public AbstractInterfaceDef create_abstract_interface(java.lang.String id,
                                                      java.lang.String name,
                                                      java.lang.String version,
                                                      AbstractInterfaceDef[] base_interfaces)
Description copied from interface: ContainerOperations
The create_abstract_interface operation returns a new AbstractInterfaceDef with the specified name and base interfaces.
Specified by:
create_abstract_interface in interface ContainerOperations

create_local_interface

public LocalInterfaceDef create_local_interface(java.lang.String id,
                                                java.lang.String name,
                                                java.lang.String version,
                                                LocalInterfaceDef[] base_interfaces)
Description copied from interface: ContainerOperations
The create_local_interface operation returns a new LocalInterfaceDef with the specified name and base interfaces.
Specified by:
create_local_interface in interface ContainerOperations

def_kind

public DefinitionKind def_kind()
Description copied from interface: IRObjectOperations
The def_kind type_name attribute identifies the type of the definition.
Specified by:
def_kind in interface IRObjectOperations

destroy

public void destroy()
Description copied from interface: IRObjectOperations
The destroy operation causes the object to cease to exist. If the object is a Container, destroy is applied to all its contents. If the object contains an IDLType attribute for an anonymous type, that IDLType is destroyed. If the object is currently contained in some other object, it is removed. If destroy is invoked on a Repository or on a PrimitiveDef then the BAD_INV_ORDER exception is raised with minor value 2. Implementations may vary in their handling of references to an object that is being destroyed, but the Repository should not be left in an incoherent state. Attempt to destroy an object that would leave the repository in an incoherent state shall cause BAD_INV_ORDER exception to be raised with the minor code 1.
Specified by:
destroy in interface IRObjectOperations