ImageFormatter

java.lang.Object

rife.cmf.format.ImageFormatter

All Implemented Interfaces:: Formatter<byte[],Image>

public class ImageFormatter extends Object implements Formatter<byte[],Image>

Formats raw Content data as an image.

The following content attributes are supported:

Content Attributes
`width`	Changes the width of the image. If no height is provided, the image will be proportionally scaled.
`height`	Changes the height of the image. If no width is provided, the image will be proportionally scaled.
`longest-edge-length`	Changes the longest edge of the image. Aspect ratio is preserved. The "width" or "height" attributes take precedence if set, and this attribute will be ignored.

Since:

1.0

See Also:

Formatter

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static final class

ImageFormatter.CmfProperty

static final class

ImageFormatter.ContentAttribute
Constructor Summary

Constructors

Constructor

Description

ImageFormatter()
Method Summary

Modifier and Type

Method

Description

byte[]

format(Content content, ContentTransformer<Image> transformer)

Formats raw data and returns it in a DataType that's supported by the back-end stores.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- ImageFormatter
  
  public ImageFormatter()
Method Details
- format
  
  public byte[] format(Content content, ContentTransformer<Image> transformer) throws FormatException
  
  Description copied from interface: Formatter
  
  Formats raw data and returns it in a DataType that's supported by the back-end stores.
  
  Specified by:
  
  format in interface Formatter<byte[],Image>
  
  Parameters:
  
  content - a Content instance that contains the raw data with additional information that describes the storage and formatting of the processed data
  
  transformer - a transformer that will be used to modify raw data after it has been loaded; or
  null if the data shouldn't be transformed
  
  Returns:
  
  the result of the formatting of the raw data
  
  Throws:
  
  FormatException