Package model

Class MtrOptions.MtrOptionsBuilder

java.lang.Object

model.MtrOptions.MtrOptionsBuilder

Enclosing class:

MtrOptions

public static class MtrOptions.MtrOptionsBuilder
extends Object

This class represents a builder for Mtr Options.

Constructor Summary

Constructors

Constructor	Description
MtrOptionsBuilder()	Constructor of Builder MtrOptions.MtrOptionsBuilder.

Method Summary

Modifier and Type	Method	Description
MtrOptions	build()	Final method in the chain to build MtrOptions object.
MtrOptions.MtrOptionsBuilder	withIpVersion(int ipVersion)	Chain method for setting value of ipVersion.
MtrOptions.MtrOptionsBuilder	withPackets(int packets)	Chain method for setting value of packets.
MtrOptions.MtrOptionsBuilder	withPort(int port)	Chain method for setting value of port.
MtrOptions.MtrOptionsBuilder	withProtocol(MeasurementProtocol protocol)	Chain method for setting value of protocol.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MtrOptionsBuilder

public MtrOptionsBuilder()

Constructor of Builder MtrOptions.MtrOptionsBuilder.

Example Usage:

    MtrOptions mtr = new MtrOptionsBuilder().withPort(80).build();
 
 

Method Details

withPort

public MtrOptions.MtrOptionsBuilder withPort(int port)
                                      throws PayloadException

Chain method for setting value of port.

Parameters:

port - int value within the range of 0 to 65535

Returns:

MtrOptions.MtrOptionsBuilder

Throws:

PayloadException - if port param is invalid

withProtocol

public MtrOptions.MtrOptionsBuilder withProtocol(MeasurementProtocol protocol)

Chain method for setting value of protocol.

Parameters:

protocol - MeasurementProtocol

Returns:

MtrOptions.MtrOptionsBuilder

withIpVersion

public MtrOptions.MtrOptionsBuilder withIpVersion(int ipVersion)
                                           throws PayloadException

Chain method for setting value of ipVersion.

Parameters:

ipVersion - int value for IP Version 4|6.

Returns:

MtrOptions.MtrOptionsBuilder

Throws:

PayloadException - if protocol param value is invalid EXPERIMENTAL: The IP version to use. Only allowed if the target is a hostname.

withPackets

public MtrOptions.MtrOptionsBuilder withPackets(int packets)
                                         throws PayloadException

Chain method for setting value of packets.

Parameters:

packets - int value within the range of 1 to 16

Returns:

MtrOptions.MtrOptionsBuilder

Throws:

PayloadException - if packets param is invalid

build

public MtrOptions build()

Final method in the chain to build MtrOptions object.

Returns:

MtrOptions