com.google.ortools.linearsolver.MPModelProto.Annotation Class Reference

Inheritance diagram for com.google.ortools.linearsolver.MPModelProto.Annotation:

Classes
class	Builder
enum	TargetType

Public Member Functions
boolean	hasTargetType ()
com.google.ortools.linearsolver.MPModelProto.Annotation.TargetType	getTargetType ()
boolean	hasTargetIndex ()
int	getTargetIndex ()
boolean	hasTargetName ()
java.lang.String	getTargetName ()
com.google.protobuf.ByteString	getTargetNameBytes ()
boolean	hasPayloadKey ()
java.lang.String	getPayloadKey ()
com.google.protobuf.ByteString	getPayloadKeyBytes ()
boolean	hasPayloadValue ()
java.lang.String	getPayloadValue ()
com.google.protobuf.ByteString	getPayloadValueBytes ()
final boolean	isInitialized ()
void	writeTo (com.google.protobuf.CodedOutputStream output) throws java.io.IOException
int	getSerializedSize ()
boolean	equals (final java.lang.Object obj)
int	hashCode ()
Builder	newBuilderForType ()
Builder	toBuilder ()
com.google.protobuf.Parser< Annotation >	getParserForType ()
com.google.ortools.linearsolver.MPModelProto.Annotation	getDefaultInstanceForType ()

Static Public Member Functions
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor ()
static com.google.ortools.linearsolver.MPModelProto.Annotation	parseFrom (java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.linearsolver.MPModelProto.Annotation	parseFrom (java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.linearsolver.MPModelProto.Annotation	parseFrom (com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.linearsolver.MPModelProto.Annotation	parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.linearsolver.MPModelProto.Annotation	parseFrom (byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.linearsolver.MPModelProto.Annotation	parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.linearsolver.MPModelProto.Annotation	parseFrom (java.io.InputStream input) throws java.io.IOException
static com.google.ortools.linearsolver.MPModelProto.Annotation	parseFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
static com.google.ortools.linearsolver.MPModelProto.Annotation	parseDelimitedFrom (java.io.InputStream input) throws java.io.IOException
static com.google.ortools.linearsolver.MPModelProto.Annotation	parseDelimitedFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
static com.google.ortools.linearsolver.MPModelProto.Annotation	parseFrom (com.google.protobuf.CodedInputStream input) throws java.io.IOException
static com.google.ortools.linearsolver.MPModelProto.Annotation	parseFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
static Builder	newBuilder ()
static Builder	newBuilder (com.google.ortools.linearsolver.MPModelProto.Annotation prototype)
static com.google.ortools.linearsolver.MPModelProto.Annotation	getDefaultInstance ()
static com.google.protobuf.Parser< Annotation >	parser ()

Static Public Attributes
static final int	TARGET_TYPE_FIELD_NUMBER = 1
static final int	TARGET_INDEX_FIELD_NUMBER = 2
static final int	TARGET_NAME_FIELD_NUMBER = 3
static final int	PAYLOAD_KEY_FIELD_NUMBER = 4
static final int	PAYLOAD_VALUE_FIELD_NUMBER = 5
static final com.google.protobuf.Parser< Annotation >	PARSER

Protected Member Functions
java.lang.Object	newInstance (UnusedPrivateParameter unused)
com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable ()
Builder	newBuilderForType (com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Detailed Description

Annotations can be freely added by users who want to attach arbitrary
payload to the model's variables or constraints.

Protobuf type operations_research.MPModelProto.Annotation

Definition at line 173 of file MPModelProto.java.

Member Function Documentation

equals()

boolean com.google.ortools.linearsolver.MPModelProto.Annotation.equals

(

final java.lang.Object

obj

)

Definition at line 602 of file MPModelProto.java.

getDefaultInstance()

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.getDefaultInstance ( )

static

Definition at line 1421 of file MPModelProto.java.

getDefaultInstanceForType()

com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.getDefaultInstanceForType

(

)

Definition at line 1457 of file MPModelProto.java.

getDescriptor()

static final com.google.protobuf.Descriptors.Descriptor com.google.ortools.linearsolver.MPModelProto.Annotation.getDescriptor ( )

static

Definition at line 197 of file MPModelProto.java.

getParserForType()

com.google.protobuf.Parser< Annotation > com.google.ortools.linearsolver.MPModelProto.Annotation.getParserForType

(

)

Definition at line 1452 of file MPModelProto.java.

getPayloadKey()

java.lang.String com.google.ortools.linearsolver.MPModelProto.Annotation.getPayloadKey

(

)

The payload is a (key, value) string pair. Depending on the use cases,
one of the two may be omitted.

optional string payload_key = 4;

Returns

The payloadKey.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 454 of file MPModelProto.java.

getPayloadKeyBytes()

com.google.protobuf.ByteString com.google.ortools.linearsolver.MPModelProto.Annotation.getPayloadKeyBytes

(

)

The payload is a (key, value) string pair. Depending on the use cases,
one of the two may be omitted.

optional string payload_key = 4;

Returns

The bytes for payloadKey.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 479 of file MPModelProto.java.

getPayloadValue()

java.lang.String com.google.ortools.linearsolver.MPModelProto.Annotation.getPayloadValue

(

)

optional string payload_value = 5;

Returns

The payloadValue.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 508 of file MPModelProto.java.

getPayloadValueBytes()

com.google.protobuf.ByteString com.google.ortools.linearsolver.MPModelProto.Annotation.getPayloadValueBytes

(

)

optional string payload_value = 5;

Returns

The bytes for payloadValue.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 528 of file MPModelProto.java.

getSerializedSize()

int com.google.ortools.linearsolver.MPModelProto.Annotation.getSerializedSize

(

)

Definition at line 574 of file MPModelProto.java.

getTargetIndex()

int com.google.ortools.linearsolver.MPModelProto.Annotation.getTargetIndex

(

)

If both `target_index` and `target_name` are set, they must point to the
same entity.

optional int32 target_index = 2;

Returns

The targetIndex.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 363 of file MPModelProto.java.

getTargetName()

java.lang.String com.google.ortools.linearsolver.MPModelProto.Annotation.getTargetName

(

)

Alternate to index. Assumes uniqueness.

optional string target_name = 3;

Returns

The targetName.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 391 of file MPModelProto.java.

getTargetNameBytes()

com.google.protobuf.ByteString com.google.ortools.linearsolver.MPModelProto.Annotation.getTargetNameBytes

(

)

Alternate to index. Assumes uniqueness.

optional string target_name = 3;

Returns

The bytes for targetName.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 415 of file MPModelProto.java.

getTargetType()

com.google.ortools.linearsolver.MPModelProto.Annotation.TargetType com.google.ortools.linearsolver.MPModelProto.Annotation.getTargetType

(

)

optional .operations_research.MPModelProto.Annotation.TargetType target_type = 1;

Returns

The targetType.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 333 of file MPModelProto.java.

hashCode()

int com.google.ortools.linearsolver.MPModelProto.Annotation.hashCode

(

)

Definition at line 640 of file MPModelProto.java.

hasPayloadKey()

boolean com.google.ortools.linearsolver.MPModelProto.Annotation.hasPayloadKey

(

)

The payload is a (key, value) string pair. Depending on the use cases,
one of the two may be omitted.

optional string payload_key = 4;

Returns

Whether the payloadKey field is set.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 441 of file MPModelProto.java.

hasPayloadValue()

boolean com.google.ortools.linearsolver.MPModelProto.Annotation.hasPayloadValue

(

)

optional string payload_value = 5;

Returns

Whether the payloadValue field is set.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 500 of file MPModelProto.java.

hasTargetIndex()

boolean com.google.ortools.linearsolver.MPModelProto.Annotation.hasTargetIndex

(

)

If both `target_index` and `target_name` are set, they must point to the
same entity.

optional int32 target_index = 2;

Returns

Whether the targetIndex field is set.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 350 of file MPModelProto.java.

hasTargetName()

boolean com.google.ortools.linearsolver.MPModelProto.Annotation.hasTargetName

(

)

Alternate to index. Assumes uniqueness.

optional string target_name = 3;

Returns

Whether the targetName field is set.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 379 of file MPModelProto.java.

hasTargetType()

boolean com.google.ortools.linearsolver.MPModelProto.Annotation.hasTargetType

(

)

optional .operations_research.MPModelProto.Annotation.TargetType target_type = 1;

Returns

Whether the targetType field is set.

Implements com.google.ortools.linearsolver.MPModelProto.AnnotationOrBuilder.

Definition at line 326 of file MPModelProto.java.

internalGetFieldAccessorTable()

com.google.protobuf.GeneratedMessageV3.FieldAccessorTable com.google.ortools.linearsolver.MPModelProto.Annotation.internalGetFieldAccessorTable ( )

protected

Definition at line 203 of file MPModelProto.java.

isInitialized()

final boolean com.google.ortools.linearsolver.MPModelProto.Annotation.isInitialized

(

)

Definition at line 543 of file MPModelProto.java.

newBuilder() [1/2]

static Builder com.google.ortools.linearsolver.MPModelProto.Annotation.newBuilder ( )

static

Definition at line 745 of file MPModelProto.java.

newBuilder() [2/2]

static Builder com.google.ortools.linearsolver.MPModelProto.Annotation.newBuilder ( com.google.ortools.linearsolver.MPModelProto.Annotation prototype )

static

Definition at line 748 of file MPModelProto.java.

newBuilderForType() [1/2]

Builder com.google.ortools.linearsolver.MPModelProto.Annotation.newBuilderForType

(

)

Definition at line 744 of file MPModelProto.java.

newBuilderForType() [2/2]

Builder com.google.ortools.linearsolver.MPModelProto.Annotation.newBuilderForType ( com.google.protobuf.GeneratedMessageV3.BuilderParent parent )

protected

Definition at line 758 of file MPModelProto.java.

newInstance()

java.lang.Object com.google.ortools.linearsolver.MPModelProto.Annotation.newInstance ( UnusedPrivateParameter unused )

protected

Definition at line 191 of file MPModelProto.java.

parseDelimitedFrom() [1/2]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseDelimitedFrom ( java.io.InputStream input ) throws java.io.IOException

static

Definition at line 716 of file MPModelProto.java.

parseDelimitedFrom() [2/2]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseDelimitedFrom ( java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws java.io.IOException

static

Definition at line 722 of file MPModelProto.java.

parseFrom() [1/10]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseFrom ( byte[] data ) throws com.google.protobuf.InvalidProtocolBufferException

static

Definition at line 693 of file MPModelProto.java.

parseFrom() [2/10]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseFrom ( byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws com.google.protobuf.InvalidProtocolBufferException

static

Definition at line 697 of file MPModelProto.java.

parseFrom() [3/10]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseFrom ( com.google.protobuf.ByteString data ) throws com.google.protobuf.InvalidProtocolBufferException

static

Definition at line 682 of file MPModelProto.java.

parseFrom() [4/10]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseFrom ( com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws com.google.protobuf.InvalidProtocolBufferException

static

Definition at line 687 of file MPModelProto.java.

parseFrom() [5/10]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseFrom ( com.google.protobuf.CodedInputStream input ) throws java.io.IOException

static

Definition at line 729 of file MPModelProto.java.

parseFrom() [6/10]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseFrom ( com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws java.io.IOException

static

Definition at line 735 of file MPModelProto.java.

parseFrom() [7/10]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseFrom ( java.io.InputStream input ) throws java.io.IOException

static

Definition at line 703 of file MPModelProto.java.

parseFrom() [8/10]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseFrom ( java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws java.io.IOException

static

Definition at line 708 of file MPModelProto.java.

parseFrom() [9/10]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseFrom ( java.nio.ByteBuffer data ) throws com.google.protobuf.InvalidProtocolBufferException

static

Definition at line 671 of file MPModelProto.java.

parseFrom() [10/10]

static com.google.ortools.linearsolver.MPModelProto.Annotation com.google.ortools.linearsolver.MPModelProto.Annotation.parseFrom ( java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws com.google.protobuf.InvalidProtocolBufferException

static

Definition at line 676 of file MPModelProto.java.

parser()

static com.google.protobuf.Parser< Annotation > com.google.ortools.linearsolver.MPModelProto.Annotation.parser ( )

static

Definition at line 1447 of file MPModelProto.java.

toBuilder()

Builder com.google.ortools.linearsolver.MPModelProto.Annotation.toBuilder

(

)

Definition at line 752 of file MPModelProto.java.

writeTo()

void com.google.ortools.linearsolver.MPModelProto.Annotation.writeTo

(

com.google.protobuf.CodedOutputStream

output

)

throws java.io.IOException

Definition at line 553 of file MPModelProto.java.

Member Data Documentation

PARSER

final com.google.protobuf.Parser<Annotation> com.google.ortools.linearsolver.MPModelProto.Annotation.PARSER

static

Initial value:

= new com.google.protobuf.AbstractParser<Annotation>() {
      @java.lang.Override
      public Annotation parsePartialFrom(
          com.google.protobuf.CodedInputStream input,
          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
          throws com.google.protobuf.InvalidProtocolBufferException {
        Builder builder = newBuilder();
        try {
          builder.mergeFrom(input, extensionRegistry);
        } catch (com.google.protobuf.InvalidProtocolBufferException e) {
          throw e.setUnfinishedMessage(builder.buildPartial());
        } catch (com.google.protobuf.UninitializedMessageException e) {
          throw e.asInvalidProtocolBufferException().setUnfinishedMessage(builder.buildPartial());
        } catch (java.io.IOException e) {
          throw new com.google.protobuf.InvalidProtocolBufferException(e)
              .setUnfinishedMessage(builder.buildPartial());
        }
        return builder.buildPartial();
      }
    }

Definition at line 1426 of file MPModelProto.java.

PAYLOAD_KEY_FIELD_NUMBER

final int com.google.ortools.linearsolver.MPModelProto.Annotation.PAYLOAD_KEY_FIELD_NUMBER = 4

static

Definition at line 428 of file MPModelProto.java.

PAYLOAD_VALUE_FIELD_NUMBER

final int com.google.ortools.linearsolver.MPModelProto.Annotation.PAYLOAD_VALUE_FIELD_NUMBER = 5

static

Definition at line 492 of file MPModelProto.java.

TARGET_INDEX_FIELD_NUMBER

final int com.google.ortools.linearsolver.MPModelProto.Annotation.TARGET_INDEX_FIELD_NUMBER = 2

static

Definition at line 338 of file MPModelProto.java.

TARGET_NAME_FIELD_NUMBER

final int com.google.ortools.linearsolver.MPModelProto.Annotation.TARGET_NAME_FIELD_NUMBER = 3

static

Definition at line 367 of file MPModelProto.java.

TARGET_TYPE_FIELD_NUMBER

final int com.google.ortools.linearsolver.MPModelProto.Annotation.TARGET_TYPE_FIELD_NUMBER = 1

static

Definition at line 320 of file MPModelProto.java.

---

The documentation for this class was generated from the following file:

• build/java/ortools-java/src/main/java/com/google/ortools/linearsolver/MPModelProto.java