aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache/fop/render/afp/modca/AbstractPreparedAFPObject.java
blob: e40aa1b4fc17ea0cc8db8e2e97af0752a2102c25 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/* $Id: $ */

package org.apache.fop.render.afp.modca;

import java.io.IOException;
import java.io.OutputStream;


/**
 * A base class that carries out early preparation of structured field data
 * for the AFP object (so the data length can be pre-calculated)
 */
public abstract class AbstractPreparedAFPObject extends AbstractNamedAFPObject
implements PreparedAFPObject {

    /** structured field data to be written */
    protected byte[] data = null;

    /**
     * Default constructor
     */
    public AbstractPreparedAFPObject() {
    }

    /**
     * Named constructor
     * @param name the name of this AFP object
     */
    public AbstractPreparedAFPObject(String name) {
        super(name);
    }

    /**
     * {@inheritDoc}
     */
    protected void writeContent(OutputStream os) throws IOException {
        super.writeContent(os); // write triplets
        if (this.data != null) {
            os.write(this.data);
        }
    }

    /**
     * @return the start data length of this structured field
     */
    protected int getStartDataLength() {
        return 0;
    }
    
    /**
     * @return the data length of the structured field data of this AFP object
     */
    public int getDataLength() {
        if (this.data != null) {
            return this.data.length;
        }
        return 0;
    }
    
    /**
     * @return the structured field length
     */
    protected int getLength() {
        return getStartDataLength() + getTripletDataLength() + getDataLength();
    }
}