Class Barcode (2.57.0) 

public final class Barcode extends GeneratedMessageV3 implements BarcodeOrBuilder

Encodes the detailed information of a barcode.

Protobuf type google.cloud.documentai.v1beta3.Barcode

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Barcode

Implements

BarcodeOrBuilder

Static Fields

FORMAT_FIELD_NUMBER

public static final int FORMAT_FIELD_NUMBER
Field Value
Type Description
int

RAW_VALUE_FIELD_NUMBER

public static final int RAW_VALUE_FIELD_NUMBER
Field Value
Type Description
int

VALUE_FORMAT_FIELD_NUMBER

public static final int VALUE_FORMAT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Barcode getDefaultInstance()
Returns
Type Description
Barcode

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Barcode.Builder newBuilder()
Returns
Type Description
Barcode.Builder

newBuilder(Barcode prototype)

public static Barcode.Builder newBuilder(Barcode prototype)
Parameter
Name Description
prototype Barcode
Returns
Type Description
Barcode.Builder

parseDelimitedFrom(InputStream input)

public static Barcode parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Barcode
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Barcode parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Barcode
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Barcode parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Barcode
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Barcode parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Barcode
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Barcode parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Barcode
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Barcode parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Barcode
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Barcode parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Barcode
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Barcode parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Barcode
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Barcode parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Barcode
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Barcode parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Barcode
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Barcode parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Barcode
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Barcode parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Barcode
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Barcode> parser()
Returns
Type Description
Parser<Barcode>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Barcode getDefaultInstanceForType()
Returns
Type Description
Barcode

getFormat()

public String getFormat()

Format of a barcode. The supported formats are:

  • CODE_128: Code 128 type.
  • CODE_39: Code 39 type.
  • CODE_93: Code 93 type.
  • CODABAR: Codabar type.
  • DATA_MATRIX: 2D Data Matrix type.
  • ITF: ITF type.
  • EAN_13: EAN-13 type.
  • EAN_8: EAN-8 type.
  • QR_CODE: 2D QR code type.
  • UPC_A: UPC-A type.
  • UPC_E: UPC-E type.
  • PDF417: PDF417 type.
  • AZTEC: 2D Aztec code type.
  • DATABAR: GS1 DataBar code type.

string format = 1;

Returns
Type Description
String

The format.

getFormatBytes()

public ByteString getFormatBytes()

Format of a barcode. The supported formats are:

  • CODE_128: Code 128 type.
  • CODE_39: Code 39 type.
  • CODE_93: Code 93 type.
  • CODABAR: Codabar type.
  • DATA_MATRIX: 2D Data Matrix type.
  • ITF: ITF type.
  • EAN_13: EAN-13 type.
  • EAN_8: EAN-8 type.
  • QR_CODE: 2D QR code type.
  • UPC_A: UPC-A type.
  • UPC_E: UPC-E type.
  • PDF417: PDF417 type.
  • AZTEC: 2D Aztec code type.
  • DATABAR: GS1 DataBar code type.

string format = 1;

Returns
Type Description
ByteString

The bytes for format.

getParserForType()

public Parser<Barcode> getParserForType()
Returns
Type Description
Parser<Barcode>
Overrides

getRawValue()

public String getRawValue()

Raw value encoded in the barcode. For example: 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.

string raw_value = 3;

Returns
Type Description
String

The rawValue.

getRawValueBytes()

public ByteString getRawValueBytes()

Raw value encoded in the barcode. For example: 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.

string raw_value = 3;

Returns
Type Description
ByteString

The bytes for rawValue.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getValueFormat()

public String getValueFormat()

Value format describes the format of the value that a barcode encodes. The supported formats are:

  • CONTACT_INFO: Contact information.
  • EMAIL: Email address.
  • ISBN: ISBN identifier.
  • PHONE: Phone number.
  • PRODUCT: Product.
  • SMS: SMS message.
  • TEXT: Text string.
  • URL: URL address.
  • WIFI: Wifi information.
  • GEO: Geo-localization.
  • CALENDAR_EVENT: Calendar event.
  • DRIVER_LICENSE: Driver's license.

string value_format = 2;

Returns
Type Description
String

The valueFormat.

getValueFormatBytes()

public ByteString getValueFormatBytes()

Value format describes the format of the value that a barcode encodes. The supported formats are:

  • CONTACT_INFO: Contact information.
  • EMAIL: Email address.
  • ISBN: ISBN identifier.
  • PHONE: Phone number.
  • PRODUCT: Product.
  • SMS: SMS message.
  • TEXT: Text string.
  • URL: URL address.
  • WIFI: Wifi information.
  • GEO: Geo-localization.
  • CALENDAR_EVENT: Calendar event.
  • DRIVER_LICENSE: Driver's license.

string value_format = 2;

Returns
Type Description
ByteString

The bytes for valueFormat.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Barcode.Builder newBuilderForType()
Returns
Type Description
Barcode.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Barcode.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Barcode.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Barcode.Builder toBuilder()
Returns
Type Description
Barcode.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException