Apache PDFBox 3.0.4 · org.apache.pdfbox.jbig2.util.Utils

Modifier and Type	Field and Description
private static final double	BIG_ENOUGH_FLOOR
private static final int	BIG_ENOUGH_INT
private static final double	BIG_ENOUGH_ROUND

Access	Constructor and Description
public	Utils()

Method Summary

Modifier and Type	Method and Description
public static int	Returns: resulting ceil value ceil(double the argument x) A fast implementation of `Math#ceil(double)`.
public static double	Returns: the clamped value clamp(double input value value, double minimal value min, double maximal value max) Clamp the value into the range [min..max].
public static Rectangle2D	Returns: the resulting rectangle dilateRect(Rectangle2D the given rectangle r, double horizontal value of the additional margin marginX, double vertical value of the additional margin marginY) Return a new rectangle which covers the area of the given rectangle with an additional margin on the sides.
public static Rectangle	Returns: the resulting rectangle enlargeRectToGrid(Rectangle2D the given rectangle r) Create a rectangle with the same area as the given input rectangle but with all of its edges snapped (rounded) to the integer grid.
public static int	Returns: resulting floor value floor(double the argument x) A fast implementation of `Math#floor(double)`.
public static int	Returns: rounded value round(double the argument x) A fast implementation of `Math#round(double)`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

BIG_ENOUGH_FLOOR	back to summary
private static final double BIG_ENOUGH_FLOOR

BIG_ENOUGH_INT	back to summary
private static final int BIG_ENOUGH_INT

BIG_ENOUGH_ROUND	back to summary
private static final double BIG_ENOUGH_ROUND

Utils	back to summary
public Utils()

Method Detail

ceil back to summary

ceil	back to summary
public static int ceil(double x) A fast implementation of `Math#ceil(double)`. Parameters x:double the argument Returns:int resulting ceil value

public static int ceil(double x)

A fast implementation of Math#ceil(double).

Parameters

x:double: the argument

Returns:int

resulting ceil value

clamp	back to summary
public static double clamp(double value, double min, double max) Clamp the value into the range [min..max]. Parameters value:double input value min:double minimal value max:double maximal value Returns:double the clamped value

clamp

back to summary

public static double clamp(double value, double min, double max)

Clamp the value into the range [min..max].

Parameters

value:double: input value
min:double: minimal value
max:double: maximal value

Returns:double

the clamped value

dilateRect	back to summary
public static Rectangle2D dilateRect(Rectangle2D r, double marginX, double marginY) Return a new rectangle which covers the area of the given rectangle with an additional margin on the sides. Parameters r:Rectangle2D the given rectangle marginX:double horizontal value of the additional margin marginY:double vertical value of the additional margin Returns:Rectangle2D the resulting rectangle

dilateRect

back to summary

public static Rectangle2D dilateRect(Rectangle2D r, double marginX, double marginY)

Return a new rectangle which covers the area of the given rectangle with an additional margin on the sides.

Parameters

r:Rectangle2D: the given rectangle
marginX:double: horizontal value of the additional margin
marginY:double: vertical value of the additional margin

Returns:Rectangle2D

the resulting rectangle

enlargeRectToGrid back to summary

enlargeRectToGrid	back to summary
public static Rectangle enlargeRectToGrid(Rectangle2D r) Create a rectangle with the same area as the given input rectangle but with all of its edges snapped (rounded) to the integer grid. The resulting rectangle is guaranteed to cover all of the input rectangle's area, so that `enlargeToGrid(r).contains(r) == true` holds. This can be depicted as the edges being stretched in an outward direction. Parameters r:Rectangle2D the given rectangle Returns:Rectangle the resulting rectangle

public static Rectangle enlargeRectToGrid(Rectangle2D r)

Create a rectangle with the same area as the given input rectangle but with all of its edges snapped (rounded) to the integer grid. The resulting rectangle is guaranteed to cover all of the input rectangle's area, so that enlargeToGrid(r).contains(r) == true holds. This can be depicted as the edges being stretched in an outward direction.

Parameters

r:Rectangle2D: the given rectangle

Returns:Rectangle

the resulting rectangle

floor back to summary

floor	back to summary
public static int floor(double x) A fast implementation of `Math#floor(double)`. Parameters x:double the argument Returns:int resulting floor value

public static int floor(double x)

A fast implementation of Math#floor(double).

Parameters

x:double: the argument

Returns:int

resulting floor value

round back to summary

round	back to summary
public static int round(double x) A fast implementation of `Math#round(double)`. Parameters x:double the argument Returns:int rounded value

public static int round(double x)

A fast implementation of Math#round(double).

Parameters

x:double: the argument

Returns:int

rounded value

public Class Utils

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail