| /* ==================================================================== |
| 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. |
| ==================================================================== */ |
| |
| package org.apache.poi.hpsf; |
| |
| import java.io.IOException; |
| import java.io.OutputStream; |
| |
| import org.apache.poi.util.LittleEndian; |
| import org.apache.poi.util.LittleEndianConsts; |
| import org.apache.poi.util.Removal; |
| |
| /** |
| * Class for writing little-endian data and more. |
| * @deprecated POI 3.16 beta 2 - use LittleEndian instead |
| */ |
| @Deprecated |
| @Removal(version="3.18") |
| public class TypeWriter |
| { |
| |
| /** |
| * <p>Writes a two-byte value (short) to an output stream.</p> |
| * |
| * @param out The stream to write to. |
| * @param n The value to write. |
| * @return The number of bytes that have been written. |
| * @exception IOException if an I/O error occurs |
| */ |
| public static int writeToStream( final OutputStream out, final short n ) |
| throws IOException |
| { |
| LittleEndian.putShort( out, n ); // FIXME: unsigned |
| return LittleEndianConsts.SHORT_SIZE; |
| } |
| |
| /** |
| * <p>Writes a four-byte value to an output stream.</p> |
| * |
| * @param out The stream to write to. |
| * @param n The value to write. |
| * @exception IOException if an I/O error occurs |
| * @return The number of bytes written to the output stream. |
| */ |
| public static int writeToStream( final OutputStream out, final int n ) |
| throws IOException |
| { |
| LittleEndian.putInt( n, out ); |
| return LittleEndianConsts.INT_SIZE; |
| } |
| |
| /** |
| * <p>Writes a eight-byte value to an output stream.</p> |
| * |
| * @param out The stream to write to. |
| * @param n The value to write. |
| * @exception IOException if an I/O error occurs |
| * @return The number of bytes written to the output stream. |
| */ |
| public static int writeToStream( final OutputStream out, final long n ) |
| throws IOException |
| { |
| LittleEndian.putLong( n, out ); |
| return LittleEndianConsts.LONG_SIZE; |
| } |
| |
| /** |
| * <p>Writes an unsigned two-byte value to an output stream.</p> |
| * |
| * @param out The stream to write to |
| * @param n The value to write |
| * @exception IOException if an I/O error occurs |
| */ |
| public static void writeUShortToStream( final OutputStream out, final int n ) |
| throws IOException |
| { |
| int high = n & 0xFFFF0000; |
| if ( high != 0 ) { |
| throw new IllegalPropertySetDataException( "Value " + n |
| + " cannot be represented by 2 bytes." ); |
| } |
| LittleEndian.putUShort( n, out ); |
| } |
| |
| /** |
| * <p>Writes an unsigned four-byte value to an output stream.</p> |
| * |
| * @param out The stream to write to. |
| * @param n The value to write. |
| * @return The number of bytes that have been written to the output stream. |
| * @exception IOException if an I/O error occurs |
| */ |
| public static int writeUIntToStream( final OutputStream out, final long n ) |
| throws IOException |
| { |
| long high = n & 0xFFFFFFFF00000000L; |
| if ( high != 0 && high != 0xFFFFFFFF00000000L ) { |
| throw new IllegalPropertySetDataException( "Value " + n |
| + " cannot be represented by 4 bytes." ); |
| } |
| LittleEndian.putUInt( n, out ); |
| return LittleEndianConsts.INT_SIZE; |
| } |
| |
| /** |
| * <p>Writes a 16-byte {@link ClassID} to an output stream.</p> |
| * |
| * @param out The stream to write to |
| * @param n The value to write |
| * @return The number of bytes written |
| * @exception IOException if an I/O error occurs |
| */ |
| public static int writeToStream(final OutputStream out, final ClassID n) |
| throws IOException |
| { |
| byte[] b = new byte[16]; |
| n.write(b, 0); |
| out.write(b, 0, b.length); |
| return b.length; |
| } |
| |
| |
| |
| /** |
| * <p>Writes an array of {@link Property} instances to an output stream |
| * according to the Horrible Property Stream Format.</p> |
| * |
| * @param out The stream to write to |
| * @param properties The array to write to the stream |
| * @param codepage The codepage number to use for writing strings |
| * @exception IOException if an I/O error occurs |
| * @throws UnsupportedVariantTypeException if HPSF does not support some |
| * variant type. |
| */ |
| public static void writeToStream(final OutputStream out, |
| final Property[] properties, |
| final int codepage) |
| throws IOException, UnsupportedVariantTypeException |
| { |
| /* If there are no properties don't write anything. */ |
| if (properties == null) { |
| return; |
| } |
| |
| /* Write the property list. This is a list containing pairs of property |
| * ID and offset into the stream. */ |
| for (int i = 0; i < properties.length; i++) |
| { |
| final Property p = properties[i]; |
| writeUIntToStream(out, p.getID()); |
| writeUIntToStream(out, p.getSize(codepage)); |
| } |
| |
| /* Write the properties themselves. */ |
| for (int i = 0; i < properties.length; i++) |
| { |
| final Property p = properties[i]; |
| long type = p.getType(); |
| writeUIntToStream(out, type); |
| VariantSupport.write(out, (int) type, p.getValue(), codepage); |
| } |
| } |
| |
| |
| |
| /** |
| * <p>Writes a double value value to an output stream.</p> |
| * |
| * @param out The stream to write to. |
| * @param n The value to write. |
| * @exception IOException if an I/O error occurs |
| * @return The number of bytes written to the output stream. |
| */ |
| public static int writeToStream( final OutputStream out, final double n ) |
| throws IOException |
| { |
| LittleEndian.putDouble( n, out ); |
| return LittleEndianConsts.DOUBLE_SIZE; |
| } |
| |
| } |