01: /* ====================================================================
02: Licensed to the Apache Software Foundation (ASF) under one or more
03: contributor license agreements. See the NOTICE file distributed with
04: this work for additional information regarding copyright ownership.
05: The ASF licenses this file to You under the Apache License, Version 2.0
06: (the "License"); you may not use this file except in compliance with
07: the License. You may obtain a copy of the License at
08:
09: http://www.apache.org/licenses/LICENSE-2.0
10:
11: Unless required by applicable law or agreed to in writing, software
12: distributed under the License is distributed on an "AS IS" BASIS,
13: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: See the License for the specific language governing permissions and
15: limitations under the License.
16: ==================================================================== */
17:
18: package org.apache.poi.ddf;
19:
20: /**
21: * Interface for listening to escher serialization events.
22: *
23: * @author Glen Stampoultzis (glens at apache.org)
24: */
25: public interface EscherSerializationListener {
26: /**
27: * Fired before a given escher record is serialized.
28: *
29: * @param offset The position in the data array at which the record will be serialized.
30: * @param recordId The id of the record about to be serialized.
31: */
32: void beforeRecordSerialize(int offset, short recordId,
33: EscherRecord record);
34:
35: /**
36: * Fired after a record has been serialized.
37: *
38: * @param offset The position of the end of the serialized record + 1
39: * @param recordId The id of the record about to be serialized
40: * @param size The number of bytes written for this record. If it is a container
41: * record then this will include the size of any included records.
42: */
43: void afterRecordSerialize(int offset, short recordId, int size,
44: EscherRecord record);
45: }
|