View Javadoc
1   /*
2    * Copyright 2007, 2008, 2009 Ange Optimization ApS
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package eu.simuline.octave.type;
17  
18  /**
19   * Common interface for the octave objects.
20   */
21  public interface OctaveObject {
22  
23      /**
24       * Make a shallow copy of this object.
25       * 
26       * In general when an {@link OctaveObject} is returned from a getter,
27       * e.g. on {@link OctaveStruct} or {@link OctaveStruct},
28       * a shallow copy is returned in order to follow the way octave behaves. 
29       * This method is used to make that copy.
30       * 
31       * @return a shallow copy of this
32       */
33      OctaveObject shallowCopy();
34  
35  }