org.apache.pdfbox.util
Class BitFlagHelper

java.lang.Object
  org.apache.pdfbox.util.BitFlagHelper

public class BitFlagHelper
extends Object

This class will be used for bit flag operations.

Version:

$Revision: 1.4 $

Author:

Ben Litchfield

Method Summary

static boolean	getFlag(COSDictionary dic, COSName field, int bitFlag) Gets the boolean value from the flags at the given bit position.
static boolean	getFlag(COSDictionary dic, String field, int bitFlag) Deprecated. use getFlag(COSDictionary, COSName, int) using COSName constants instead
static void	setFlag(COSDictionary dic, COSName field, int bitFlag, boolean value) Sets the given boolean value at bitPos in the flags.
static void	setFlag(COSDictionary dic, String field, int bitFlag, boolean value) Deprecated. use setFlag(COSDictionary, COSName, int, boolean) using COSName constants instead

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setFlag

public static final void setFlag(COSDictionary dic,
                                 String field,
                                 int bitFlag,
                                 boolean value)

Deprecated. use setFlag(COSDictionary, COSName, int, boolean) using COSName constants instead

Sets the given boolean value at bitPos in the flags.

Parameters:

dic - The dictionary to set the value into.

field - The name of the field to set the value into.

bitFlag - the bit position to set the value in.

value - the value the bit position should have.

setFlag

public static final void setFlag(COSDictionary dic,
                                 COSName field,
                                 int bitFlag,
                                 boolean value)

Sets the given boolean value at bitPos in the flags.

Parameters:

dic - The dictionary to set the value into.

field - The COSName of the field to set the value into.

bitFlag - the bit position to set the value in.

value - the value the bit position should have.

getFlag

public static final boolean getFlag(COSDictionary dic,
                                    String field,
                                    int bitFlag)

Deprecated. use getFlag(COSDictionary, COSName, int) using COSName constants instead

Gets the boolean value from the flags at the given bit position.

Parameters:

dic - The dictionary to get the field from.

field - The name of the field to get the flag from.

bitFlag - the bitPosition to get the value from.

Returns:

true if the number at bitPos is '1'

getFlag

public static final boolean getFlag(COSDictionary dic,
                                    COSName field,
                                    int bitFlag)

Gets the boolean value from the flags at the given bit position.

Parameters:

dic - The dictionary to get the field from.

field - The COSName of the field to get the flag from.

bitFlag - the bitPosition to get the value from.

Returns:

true if the number at bitPos is '1'