Record Class PubSubOption.ExcludePublisher

java.lang.Object

java.lang.Record

org.wpilib.networktables.PubSubOption.ExcludePublisher

Record Components:

publisher - publisher to exclude

All Implemented Interfaces:

PubSubOption

Enclosing interface:

PubSubOption

public static record PubSubOption.ExcludePublisher(Publisher publisher)
extends Record
implements PubSubOption

Don't queue value updates for the given publisher. Only has an effect on subscriptions. Only one exclusion may be set.

Nested Class Summary

Nested classes/interfaces inherited from interface PubSubOption

PubSubOption.DisableLocal, PubSubOption.DisableRemote, PubSubOption.ExcludePublisher, PubSubOption.ExcludePublisherHandle, PubSubOption.ExcludeSelf, PubSubOption.Hidden, PubSubOption.KeepDuplicates, PubSubOption.Periodic, PubSubOption.PollStorage, PubSubOption.SendAll, PubSubOption.TopicsOnly

Field Summary

Fields inherited from interface PubSubOption

DISABLE_LOCAL, DISABLE_REMOTE, ENABLE_LOCAL, ENABLE_REMOTE, EXCLUDE_SELF, HIDDEN, IGNORE_DUPLICATES, INCLUDE_SELF, KEEP_DUPLICATES, SEND_ALL, SEND_CHANGES, TOPICS_AND_VALUES, TOPICS_ONLY, VISIBLE

Constructor Summary

Constructors

Constructor	Description
ExcludePublisher(Publisher publisher)	Creates an instance of a ExcludePublisher record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Publisher	publisher()	Returns the value of the publisher record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ExcludePublisher

public ExcludePublisher(Publisher publisher)

Creates an instance of a ExcludePublisher record class.

Parameters:

publisher - the value for the publisher record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

publisher

public Publisher publisher()

Returns the value of the publisher record component.

Returns:

the value of the publisher record component