Banner (anoa-tests 3.1.2 API)

All Superinterfaces:

Comparable<Banner<?>>, Serializable, Supplier<T>

All Known Implementing Classes:

Banner.Avro, Banner.NativeImpl, Banner.Protobuf, Banner.Thrift
```
public interface Banner<T>
extends Supplier<T>, Comparable<Banner<?>>, Serializable
```
3.3.3 Banner Object The “banner” object _must_ be included directly in the impression object if the impression offered for auction is display or rich media, or it may be _optionally_ embedded in the video object to describe the companion banners available for the linear or non-linear video ad. The banner object may include a unique identifier; this can be useful if these IDs can be leveraged in the VAST response to dictate placement of the companion creatives when multiple companion ad opportunities of the same size are available on a page.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Banner.Avro`
`static class`	`Banner.AvroBuilder`
`static interface`	`Banner.Builder<T>`
`static class`	`Banner.Comparator`
`static class`	`Banner.NativeImpl`
`static class`	`Banner.Protobuf`
`static class`	`Banner.ProtobufBuilder`
`static class`	`Banner.Thrift`
`static class`	`Banner.ThriftBuilder`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static Banner.Avro`	`avro(Banner<?> instance)` Returns a wrapped Avro record based on an instance of Banner.
`static Banner.Avro`	`avro(BannerAvro wrapped)` Wraps an existing Avro record.
`default int`	`compareTo(Banner<?> other)`
`T`	`get()` Returns underlying object.
`List<Integer>`	`getApi()` List of supported API frameworks for this banner.
`static Class<BannerAvro>`	`getAvroClass()` Returns Avro record class.
`static Schema`	`getAvroSchema()` Returns Avro record schema.
`List<Integer>`	`getBattr()` Blocked creative attributes.
`List<Integer>`	`getBtype()` Blocked creative types.
`static Comparator<Banner<?>>`	`getComparator()` Returns comparator instance for Banner objects.
`List<Integer>`	`getExpdir()` Specify properties for an expandable ad.
`int`	`getH()` Height of the impression in pixels.
`int`	`getHmax()` Maximum height of the impression in pixels.
`int`	`getHmin()` Minimum height of the impression in pixels.
`String`	`getId()` Unique identifier for this banner object.
`List<String>`	`getMimes()` Whitelist of content MIME types supported.
`int`	`getPos()` Ad Position.
`static Class<OpenRtbProtobuf.Banner>`	`getProtobufClass()` Returns Protobuf class for this struct.
`static com.google.protobuf.Descriptors.Descriptor`	`getProtobufDescriptor()` Returns Protobuf descriptor for this struct.
`static Class<AdExchangeProtobuf>`	`getProtobufProtocolClass()` Returns Protobuf protocol class for this struct.
`static com.google.protobuf.Descriptors.FileDescriptor`	`getProtobufProtocolDescriptor()` Returns Protobuf protocol descriptor for this struct.
`static Class<BannerThrift>`	`getThriftClass()` Returns Thrift class for this struct.
`static Map<BannerThrift._Fields,FieldMetaData>`	`getThriftMetadataMap()` Returns Thrift metadata map for this struct.
`int`	`getTopframe()` Specify if the banner is delivered in the top frame or in an iframe.
`int`	`getW()` Width of the impression in pixels.
`int`	`getWmax()` Maximum width of the impression in pixels.
`int`	`getWmin()` Minimum width of the impression in pixels.
`default boolean`	`isDefault()` True if all fields are set to default values.
`boolean`	`isDefaultApi()`
`boolean`	`isDefaultBattr()`
`boolean`	`isDefaultBtype()`
`boolean`	`isDefaultExpdir()`
`boolean`	`isDefaultH()`
`boolean`	`isDefaultHmax()`
`boolean`	`isDefaultHmin()`
`boolean`	`isDefaultId()`
`boolean`	`isDefaultMimes()`
`boolean`	`isDefaultPos()`
`boolean`	`isDefaultTopframe()`
`boolean`	`isDefaultW()`
`boolean`	`isDefaultWmax()`
`boolean`	`isDefaultWmin()`
`static Banner.NativeImpl`	`nativeImpl(Banner<?> instance)` Returns a POJO based on an instance of Banner.
`static Banner.Builder<BannerAvro>`	`newAvroBuilder()` Returns new Avro builder instance with default values.
`static Banner.Builder<BannerAvro>`	`newAvroBuilder(Banner<?> other)` Returns new Avro builder instance based on existing prototype Banner.
`static Banner.Builder<BannerAvro>`	`newAvroBuilder(BannerAvro.Builder other)` Returns new Avro builder instance based on existing prototype builder.
`static Banner.Builder<BannerAvro>`	`newAvroBuilder(BannerAvro other)` Returns new Avro builder instance based on existing prototype.
`Banner.Builder<T>`	`newBuilder()` Creates a new builder based on this object.
`static Banner.Builder<Banner.NativeImpl>`	`newNativeImplBuilder()` Returns a POJO builder instance with default values.
`static Banner.Builder<Banner.NativeImpl>`	`newNativeImplBuilder(Banner<?> other)` Returns a POJO builder instance based on existing prototype Banner.
`static Banner.Builder<OpenRtbProtobuf.Banner>`	`newProtobufBuilder()` Returns new Protobuf builder instance with default values.
`static Banner.Builder<OpenRtbProtobuf.Banner>`	`newProtobufBuilder(Banner<?> other)` Returns new Protobuf builder instance based on existing prototype Banner.
`static Banner.Builder<OpenRtbProtobuf.Banner>`	`newProtobufBuilder(OpenRtbProtobuf.Banner other)` Returns new Protobuf builder instance based on existing prototype.
`static Banner.Builder<BannerThrift>`	`newThriftBuilder()` Returns new Thrift builder instance with default values.
`static Banner.Builder<BannerThrift>`	`newThriftBuilder(Banner<?> other)` Returns new Thrift builder instance based on existing prototype Banner.
`static Banner.Builder<BannerThrift>`	`newThriftBuilder(BannerThrift other)` Returns new Thrift builder instance based on existing prototype.
`static Banner.Protobuf`	`protobuf(Banner<?> instance)` Returns a wrapped Protobuf message based on an instance of Banner.
`static Banner.Protobuf`	`protobuf(OpenRtbProtobuf.Banner wrapped)` Wraps an existing Protobuf message.
`static Banner.Thrift`	`thrift(Banner<?> instance)` Returns a wrapped Thrift struct based on an instance of Banner.
`static Banner.Thrift`	`thrift(BannerThrift instance)` Creates a new wrapped Thrift struct copied from an existing instance.

- Method Detail
  - isDefault
```
default boolean isDefault()
```
    True if all fields are set to default values.
  - get
```
T get()
```
    Returns underlying object.
    
    Specified by:
    
    get in interface Supplier<T>
  - newBuilder
```
Banner.Builder<T> newBuilder()
```
    Creates a new builder based on this object.
  - getW
```
int getW()
```
    Width of the impression in pixels. Since some ad types are not restricted by size this field is not required, but it’s highly recommended that this information be included when possible.
  - isDefaultW
```
boolean isDefaultW()
```
  - getH
```
int getH()
```
    Height of the impression in pixels. Since some ad types are not restricted by size this field is not required, but it’s highly recommended that this information be included when possible.
  - isDefaultH
```
boolean isDefaultH()
```
  - getWmax
```
int getWmax()
```
    Maximum width of the impression in pixels. If included, it indicates that a range of sizes is allowed with this maximum width and "w" is taken as recommended. If not included, then "w" should be considered an exact requirement.
  - isDefaultWmax
```
boolean isDefaultWmax()
```
  - getHmax
```
int getHmax()
```
    Maximum height of the impression in pixels. If included, it indicates that a range of sizes is allowed with this maximum height and "h" is taken as recommended. If not included, then "h" should be considered an exact requirement.
  - isDefaultHmax
```
boolean isDefaultHmax()
```
  - getWmin
```
int getWmin()
```
    Minimum width of the impression in pixels. If included, it indicates that a range of sizes is allowed with this minimum width and "w" is taken as recommended. If not included, then "w" should be considered an exact requirement.
  - isDefaultWmin
```
boolean isDefaultWmin()
```
  - getHmin
```
int getHmin()
```
    Minimum height of the impression in pixels. If included, it indicates that a range of sizes is allowed with this minimum height and "h" is taken as recommended. If not included, then "h" should be considered an exact requirement.
  - isDefaultHmin
```
boolean isDefaultHmin()
```
  - getId
```
String getId()
```
    Unique identifier for this banner object. Useful for tracking multiple banner objects (e.g., in companion banner array). Usually starts with 1, increasing with each object. Combination of impression id banner object should be unique.
  - isDefaultId
```
boolean isDefaultId()
```
  - getPos
```
int getPos()
```
    Ad Position. Use Table 6.5
  - isDefaultPos
```
boolean isDefaultPos()
```
  - getBtype
```
List<Integer> getBtype()
```
    Blocked creative types. See Table 6.2 Banner Ad Types. If blank, assume all types are allowed.
  - isDefaultBtype
```
boolean isDefaultBtype()
```
  - getBattr
```
List<Integer> getBattr()
```
    Blocked creative attributes. See Table 6.3 Creative Attributes. If blank assume all types are allowed.
  - isDefaultBattr
```
boolean isDefaultBattr()
```
  - getMimes
```
List<String> getMimes()
```
    Whitelist of content MIME types supported. Popular MIME types include, but are not limited to “image/jpg”, “image/gif” and “application/x-shockwave-flash”.
  - isDefaultMimes
```
boolean isDefaultMimes()
```
  - getTopframe
```
int getTopframe()
```
    Specify if the banner is delivered in the top frame or in an iframe. “0” means it is not in the top frame, and “1” means that it is.
  - isDefaultTopframe
```
boolean isDefaultTopframe()
```
  - getExpdir
```
List<Integer> getExpdir()
```
    Specify properties for an expandable ad. See Table 6.11 Expandable Direction for possible values.
  - isDefaultExpdir
```
boolean isDefaultExpdir()
```
  - getApi
```
List<Integer> getApi()
```
    List of supported API frameworks for this banner. (See Table 6.4 API Frameworks). If an API is not explicitly listed it is assumed not to be supported.
  - isDefaultApi
```
boolean isDefaultApi()
```
  - getComparator
```
static Comparator<Banner<?>> getComparator()
```
    Returns comparator instance for Banner objects.
  - compareTo
```
default int compareTo(Banner<?> other)
```
    Specified by:
    
    compareTo in interface Comparable<Banner<?>>
  - newNativeImplBuilder
```
static Banner.Builder<Banner.NativeImpl> newNativeImplBuilder()
```
    Returns a POJO builder instance with default values.
  - newNativeImplBuilder
```
static Banner.Builder<Banner.NativeImpl> newNativeImplBuilder(Banner<?> other)
```
    Returns a POJO builder instance based on existing prototype Banner.
  - nativeImpl
```
static Banner.NativeImpl nativeImpl(Banner<?> instance)
```
    Returns a POJO based on an instance of Banner.
  - newAvroBuilder
```
static Banner.Builder<BannerAvro> newAvroBuilder()
```
    Returns new Avro builder instance with default values.
  - newAvroBuilder
```
static Banner.Builder<BannerAvro> newAvroBuilder(BannerAvro other)
```
    Returns new Avro builder instance based on existing prototype.
  - newAvroBuilder
```
static Banner.Builder<BannerAvro> newAvroBuilder(BannerAvro.Builder other)
```
    Returns new Avro builder instance based on existing prototype builder.
  - newAvroBuilder
```
static Banner.Builder<BannerAvro> newAvroBuilder(Banner<?> other)
```
    Returns new Avro builder instance based on existing prototype Banner.
  - avro
```
static Banner.Avro avro(Banner<?> instance)
```
    Returns a wrapped Avro record based on an instance of Banner.
  - avro
```
static Banner.Avro avro(BannerAvro wrapped)
```
    Wraps an existing Avro record.
  - getAvroClass
```
static Class<BannerAvro> getAvroClass()
```
    Returns Avro record class.
  - getAvroSchema
```
static Schema getAvroSchema()
```
    Returns Avro record schema.
  - newProtobufBuilder
```
static Banner.Builder<OpenRtbProtobuf.Banner> newProtobufBuilder()
```
    Returns new Protobuf builder instance with default values.
  - newProtobufBuilder
```
static Banner.Builder<OpenRtbProtobuf.Banner> newProtobufBuilder(OpenRtbProtobuf.Banner other)
```
    Returns new Protobuf builder instance based on existing prototype.
  - newProtobufBuilder
```
static Banner.Builder<OpenRtbProtobuf.Banner> newProtobufBuilder(Banner<?> other)
```
    Returns new Protobuf builder instance based on existing prototype Banner.
  - protobuf
```
static Banner.Protobuf protobuf(Banner<?> instance)
```
    Returns a wrapped Protobuf message based on an instance of Banner.
  - protobuf
```
static Banner.Protobuf protobuf(OpenRtbProtobuf.Banner wrapped)
```
    Wraps an existing Protobuf message.
  - getProtobufClass
```
static Class<OpenRtbProtobuf.Banner> getProtobufClass()
```
    Returns Protobuf class for this struct.
  - getProtobufProtocolClass
```
static Class<AdExchangeProtobuf> getProtobufProtocolClass()
```
    Returns Protobuf protocol class for this struct.
  - getProtobufDescriptor
```
static com.google.protobuf.Descriptors.Descriptor getProtobufDescriptor()
```
    Returns Protobuf descriptor for this struct.
  - getProtobufProtocolDescriptor
```
static com.google.protobuf.Descriptors.FileDescriptor getProtobufProtocolDescriptor()
```
    Returns Protobuf protocol descriptor for this struct.
  - newThriftBuilder
```
static Banner.Builder<BannerThrift> newThriftBuilder()
```
    Returns new Thrift builder instance with default values.
  - newThriftBuilder
```
static Banner.Builder<BannerThrift> newThriftBuilder(BannerThrift other)
```
    Returns new Thrift builder instance based on existing prototype.
  - newThriftBuilder
```
static Banner.Builder<BannerThrift> newThriftBuilder(Banner<?> other)
```
    Returns new Thrift builder instance based on existing prototype Banner.
  - thrift
```
static Banner.Thrift thrift(Banner<?> instance)
```
    Returns a wrapped Thrift struct based on an instance of Banner.
  - thrift
```
static Banner.Thrift thrift(BannerThrift instance)
```
    Creates a new wrapped Thrift struct copied from an existing instance.
  - getThriftClass
```
static Class<BannerThrift> getThriftClass()
```
    Returns Thrift class for this struct.
  - getThriftMetadataMap
```
static Map<BannerThrift._Fields,FieldMetaData> getThriftMetadataMap()
```
    Returns Thrift metadata map for this struct.

Interface Banner<T>

Nested Class Summary

Method Summary

Method Detail

isDefault

get

newBuilder

getW

isDefaultW

getH

isDefaultH

getWmax

isDefaultWmax

getHmax

isDefaultHmax

getWmin

isDefaultWmin

getHmin

isDefaultHmin

getId

isDefaultId

getPos

isDefaultPos

getBtype

isDefaultBtype

getBattr

isDefaultBattr

getMimes

isDefaultMimes

getTopframe

isDefaultTopframe

getExpdir

isDefaultExpdir

getApi

isDefaultApi

getComparator

compareTo

newNativeImplBuilder

newNativeImplBuilder

nativeImpl

newAvroBuilder

newAvroBuilder

newAvroBuilder

newAvroBuilder

avro

avro

getAvroClass

getAvroSchema

newProtobufBuilder

newProtobufBuilder

newProtobufBuilder

protobuf

protobuf

getProtobufClass

getProtobufProtocolClass

getProtobufDescriptor

getProtobufProtocolDescriptor

newThriftBuilder

newThriftBuilder

newThriftBuilder

thrift

thrift

getThriftClass

getThriftMetadataMap