001/* DynSequenceOperations.java -- 002 Copyright (C) 2005 Free Software Foundation, Inc. 003This file is part of GNU Classpath. 004 005GNU Classpath is free software; you can redistribute it and/or modify 006it under the terms of the GNU General Public License as published by 007the Free Software Foundation; either version 2, or (at your option) 008any later version. 009 010GNU Classpath is distributed in the hope that it will be useful, but 011WITHOUT ANY WARRANTY; without even the implied warranty of 012MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 013General Public License for more details. 014 015You should have received a copy of the GNU General Public License 016along with GNU Classpath; see the file COPYING. If not, write to the 017Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01802110-1301 USA. 019 020Linking this library statically or dynamically with other modules is 021making a combined work based on this library. Thus, the terms and 022conditions of the GNU General Public License cover the whole 023combination. 024 025As a special exception, the copyright holders of this library give you 026permission to link this library with independent modules to produce an 027executable, regardless of the license terms of these independent 028modules, and to copy and distribute the resulting executable under 029terms of your choice, provided that you also meet, for each linked 030independent module, the terms and conditions of the license of that 031module. An independent module is a module which is not derived from 032or based on this library. If you modify this library, you may extend 033this exception to your version of the library, but you are not 034obligated to do so. If you do not wish to do so, delete this 035exception statement from your version. */ 036 037 038package org.omg.DynamicAny; 039 040import org.omg.CORBA.Any; 041import org.omg.DynamicAny.DynAnyPackage.InvalidValue; 042import org.omg.DynamicAny.DynAnyPackage.TypeMismatch; 043 044/** 045 * Defines operations, applicable to DynSequence. These are basically the same 046 * operations as for {@link DynArrayOperations} with additional possibility to 047 * change the length of the sequence. If the 048 * {@link org.omg.CORBA.TypeCode#length()} method of the sequence typecode 049 * returns positive value, it is treated as a sequence bound. An attempt to 050 * extend the sequence above its bound raises {@link InvalidValue}. 051 * 052 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org) 053 */ 054public interface DynSequenceOperations 055 extends DynAnyOperations 056{ 057 /** 058 * Get the length of the sequence. 059 * 060 * @return the current sequence length that was taken from typecode or changed 061 * with set_length. 062 */ 063 int get_length(); 064 065 /** 066 * Set the length of the sequence. If the sequence is shortened, the tailing 067 * members are discarded, but the remaining content is not affected. If the 068 * new length is larger than the previous one, the new members are added to 069 * the end of the sequence. These new members are initialised to they default 070 * values. 071 * 072 * @param length the new length of the sequence. 073 * 074 * @throws InvalidValue if this is a bounded sequence, and the size being set 075 * exceeds the sequence bound. 076 */ 077 public void set_length(int length) 078 throws InvalidValue; 079 080 /** 081 * Returns the array, containing the sequence elements. 082 * 083 * @return the array of elements as an array of DynAny's. 084 */ 085 DynAny[] get_elements_as_dyn_any(); 086 087 /** 088 * Returns the array, containing the sequence elements. 089 * 090 * @return the array of elements as an array of Any's. 091 */ 092 Any[] get_elements(); 093 094 /** 095 * Sets the sequence elements from the array. The length of the sequence is 096 * set to the length of the passed array. 097 * 098 * @param value the array of elements an DynAny's. 099 * 100 * @throws TypeMismatch if the members of the passed array does not match 101 * sequence component type. 102 * 103 * @throws InvalidValue if this is a bounded sequence and the number of 104 * elements in the passed array exceeds the sequence bound. 105 */ 106 void set_elements_as_dyn_any(DynAny[] value) 107 throws TypeMismatch, InvalidValue; 108 109 /** 110 * Sets the sequence elements from the array. The length of the sequence is 111 * set to the length of the passed array. 112 * 113 * @param value the array of elements as Any's. 114 * 115 * 116 * @throws TypeMismatch if the members of the passed array does not match 117 * sequence component type. 118 * 119 * @throws InvalidValue if this is a bounded sequence and the number of 120 * elements in the passed array exceeds the sequence bound. 121 */ 122 void set_elements(Any[] value) 123 throws TypeMismatch, InvalidValue; 124}