java.lang.Object
- net.webpdf.wsclient.openapi.MetadataImage

public class MetadataImage
extends Object

Defines an image resource of a PDF document.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_BITS_PER_COMPONENT`
`static String`	`JSON_PROPERTY_HEIGHT`
`static String`	`JSON_PROPERTY_OBJECT_KEY`
`static String`	`JSON_PROPERTY_PAGE`
`static String`	`JSON_PROPERTY_SUFFIX`
`static String`	`JSON_PROPERTY_WIDTH`

Constructor Summary

Constructors
Constructor Description

MetadataImage()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MetadataImage`	`bitsPerComponent(Integer bitsPerComponent)`
`boolean`	`equals(Object o)`
`@Nullable Integer`	`getBitsPerComponent()`	The number of bits used to encode one color component.
`@Nullable Integer`	`getHeight()`	The height of the image in points.
`@Nullable String`	`getObjectKey()`	The object ID of the image resource definition.
`@Nullable Integer`	`getPage()`	The number of the page containing the image resource.
`@Nullable String`	`getSuffix()`	Returns the file type suffix of the image.
`@Nullable Integer`	`getWidth()`	The width of the image in points.
`int`	`hashCode()`
`MetadataImage`	`height(Integer height)`
`MetadataImage`	`objectKey(String objectKey)`
`MetadataImage`	`page(Integer page)`
`void`	`setBitsPerComponent(Integer bitsPerComponent)`
`void`	`setHeight(Integer height)`
`void`	`setObjectKey(String objectKey)`
`void`	`setPage(Integer page)`
`void`	`setSuffix(String suffix)`
`void`	`setWidth(Integer width)`
`MetadataImage`	`suffix(String suffix)`
`String`	`toString()`
`MetadataImage`	`width(Integer width)`

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

- Field Detail
  - JSON_PROPERTY_BITS_PER_COMPONENT
```
public static final String JSON_PROPERTY_BITS_PER_COMPONENT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_HEIGHT
```
public static final String JSON_PROPERTY_HEIGHT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_OBJECT_KEY
```
public static final String JSON_PROPERTY_OBJECT_KEY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PAGE
```
public static final String JSON_PROPERTY_PAGE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SUFFIX
```
public static final String JSON_PROPERTY_SUFFIX
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_WIDTH
```
public static final String JSON_PROPERTY_WIDTH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MetadataImage
```
public MetadataImage()
```
- Method Detail
  - bitsPerComponent
```
public MetadataImage bitsPerComponent(Integer bitsPerComponent)
```
  - getBitsPerComponent
```
@Nullable
public @Nullable Integer getBitsPerComponent()
```
    The number of bits used to encode one color component. minimum: 0
    
    Returns:
    
    bitsPerComponent
  - setBitsPerComponent
```
public void setBitsPerComponent(Integer bitsPerComponent)
```
  - height
```
public MetadataImage height(Integer height)
```
  - getHeight
```
@Nullable
public @Nullable Integer getHeight()
```
    The height of the image in points.
    
    Returns:
    
    height
  - setHeight
```
public void setHeight(Integer height)
```
  - objectKey
```
public MetadataImage objectKey(String objectKey)
```
  - getObjectKey
```
@Nullable
public @Nullable String getObjectKey()
```
    The object ID of the image resource definition. **Info:** A PDF object ID consists of two numbers, where the first number selects the object's number and the second the \"generation\" of the object. The object ID shall always be unique within the context of the document and can be used to select a specific object.
    
    Returns:
    
    objectKey
  - setObjectKey
```
public void setObjectKey(String objectKey)
```
  - page
```
public MetadataImage page(Integer page)
```
  - getPage
```
@Nullable
public @Nullable Integer getPage()
```
    The number of the page containing the image resource. minimum: 0
    
    Returns:
    
    page
  - setPage
```
public void setPage(Integer page)
```
  - suffix
```
public MetadataImage suffix(String suffix)
```
  - getSuffix
```
@Nullable
public @Nullable String getSuffix()
```
    Returns the file type suffix of the image. (This suffix depends on the used image encoding and therefore is highly reliable.)
    
    Returns:
    
    suffix
  - setSuffix
```
public void setSuffix(String suffix)
```
  - width
```
public MetadataImage width(Integer width)
```
  - getWidth
```
@Nullable
public @Nullable Integer getWidth()
```
    The width of the image in points.
    
    Returns:
    
    width
  - setWidth
```
public void setWidth(Integer width)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class MetadataImage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_BITS_PER_COMPONENT

JSON_PROPERTY_HEIGHT

JSON_PROPERTY_OBJECT_KEY

JSON_PROPERTY_PAGE

JSON_PROPERTY_SUFFIX

JSON_PROPERTY_WIDTH

Constructor Detail

MetadataImage

Method Detail

bitsPerComponent

getBitsPerComponent

setBitsPerComponent

height

getHeight

setHeight

objectKey

getObjectKey

setObjectKey

page

getPage

setPage

suffix

getSuffix

setSuffix

width

getWidth

setWidth

equals

hashCode

toString