RpcPacketFieldRangeRule (Perforce Java API 2015.1.1210280 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.perforce.p4java.impl.mapbased.rpc.packet.helper
Class RpcPacketFieldRangeRule

java.lang.Object
  com.perforce.p4java.impl.mapbased.rpc.packet.helper.RpcPacketFieldRule
      com.perforce.p4java.impl.mapbased.rpc.packet.helper.RpcPacketFieldRangeRule

public class RpcPacketFieldRangeRule
extends RpcPacketFieldRule
extends RpcPacketFieldRule

Defines the rule for a range of fields with a start field (inclusive) and a stop field (non-inclusive).

Field Summary
`protected String`	`startField` The start field (inclusive) marking the beginning of a series of fields which the field values (bytes) will not be converted to strings.
`protected String`	`stopField` The stop field (non-inclusive) marking the end of a series of fields which the field values (bytes) will not be converted to strings.

Fields inherited from class com.perforce.p4java.impl.mapbased.rpc.packet.helper.RpcPacketFieldRule
`FIELD_PATTERN, skipConversion, START_FIELD, STOP_FIELD`

Constructor Summary
`RpcPacketFieldRangeRule(String startField, String stopField)` Constructor for creating a field range rule.

Method Summary
`String`	`getStartField()` Gets the start field.
`String`	`getStopField()` Gets the stop field.
`void`	`update(String fieldName)` Updates the conversion rule.

Methods inherited from class com.perforce.p4java.impl.mapbased.rpc.packet.helper.RpcPacketFieldRule
`getInstance, isSkipConversion`

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

Field Detail

startField

protected String startField

The start field (inclusive) marking the beginning of a series of fields which the field values (bytes) will not be converted to strings.

Note: this applies to the "RANGE" rule type only.

stopField

protected String stopField

The stop field (non-inclusive) marking the end of a series of fields which the field values (bytes) will not be converted to strings.

Note: this applies to the "RANGE" rule type only.

Constructor Detail

RpcPacketFieldRangeRule

public RpcPacketFieldRangeRule(String startField,
                               String stopField)

Constructor for creating a field range rule.

Parameters:: startField - the start field, not null.; stopField - the stop field, not null.

Method Detail

update

public void update(String fieldName)

Updates the conversion rule.

Specified by:: update in class RpcPacketFieldRule

Parameters:: fieldName - the field name

getStartField

public String getStartField()

Gets the start field.

Returns:: the start field

getStopField

public String getStopField()

Gets the stop field.

Returns:: the stop field