ProtocolVersion (viaversion-api 4.9.4-SNAPSHOT API)

java.lang.Object
- com.viaversion.viaversion.api.protocol.version.ProtocolVersion

public class ProtocolVersion
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`static ProtocolVersion`	`unknown`
`static ProtocolVersion`	`v_1_6_1`
`static ProtocolVersion`	`v_1_6_2`
`static ProtocolVersion`	`v_1_6_3`
`static ProtocolVersion`	`v_1_6_4`
`static ProtocolVersion`	`v1_10`
`static ProtocolVersion`	`v1_11`
`static ProtocolVersion`	`v1_11_1`
`static ProtocolVersion`	`v1_12`
`static ProtocolVersion`	`v1_12_1`
`static ProtocolVersion`	`v1_12_2`
`static ProtocolVersion`	`v1_13`
`static ProtocolVersion`	`v1_13_1`
`static ProtocolVersion`	`v1_13_2`
`static ProtocolVersion`	`v1_14`
`static ProtocolVersion`	`v1_14_1`
`static ProtocolVersion`	`v1_14_2`
`static ProtocolVersion`	`v1_14_3`
`static ProtocolVersion`	`v1_14_4`
`static ProtocolVersion`	`v1_15`
`static ProtocolVersion`	`v1_15_1`
`static ProtocolVersion`	`v1_15_2`
`static ProtocolVersion`	`v1_16`
`static ProtocolVersion`	`v1_16_1`
`static ProtocolVersion`	`v1_16_2`
`static ProtocolVersion`	`v1_16_3`
`static ProtocolVersion`	`v1_16_4`
`static ProtocolVersion`	`v1_17`
`static ProtocolVersion`	`v1_17_1`
`static ProtocolVersion`	`v1_18`
`static ProtocolVersion`	`v1_18_2`
`static ProtocolVersion`	`v1_19`
`static ProtocolVersion`	`v1_19_1`
`static ProtocolVersion`	`v1_19_3`
`static ProtocolVersion`	`v1_19_4`
`static ProtocolVersion`	`v1_20`
`static ProtocolVersion`	`v1_20_2`
`static ProtocolVersion`	`v1_20_3`
`static ProtocolVersion`	`v1_4_6`
`static ProtocolVersion`	`v1_5_1`
`static ProtocolVersion`	`v1_5_2`
`static ProtocolVersion`	`v1_7_1`
`static ProtocolVersion`	`v1_7_6`
`static ProtocolVersion`	`v1_8`
`static ProtocolVersion`	`v1_9`
`static ProtocolVersion`	`v1_9_1`
`static ProtocolVersion`	`v1_9_2`
`static ProtocolVersion`	`v1_9_3`

Constructor Summary

Constructors
Constructor and Description
`ProtocolVersion(int version, int snapshotVersion, java.lang.String name, @Nullable VersionRange versionRange)`
`ProtocolVersion(int version, java.lang.String name)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)`
`static @Nullable ProtocolVersion`	`getClosest(java.lang.String protocol)` Returns the registered protocol version if present, else null.
`int`	`getFullSnapshotVersion()` Returns the snapshot protocol version with the snapshot indicator bit if this is a snapshot protocol version.
`java.util.Set<java.lang.String>`	`getIncludedVersions()` Returns an immutable set of all included versions if the protocol is a version range.
`static int`	`getIndex(ProtocolVersion version)` Returns the internal index of the stored protocol version.
`java.lang.String`	`getName()` Returns the version name.
`int`	`getOriginalVersion()` Returns the release version if release, snapshot version (with the snapshot indicator bit) if snapshot.
`static @NonNull ProtocolVersion`	`getProtocol(int version)` Returns a ProtocolVersion instance, even if this protocol version has not been registered.
`static java.util.List<ProtocolVersion>`	`getProtocols()` Returns an immutable list of registered protocol versions.
`int`	`getSnapshotVersion()` Returns the snapshot protocol version without the snapshot indicator bit if this is a snapshot protocol version.
`int`	`getVersion()` Returns the release protocol version.
`int`	`hashCode()`
`boolean`	`isKnown()` Returns whether the protocol is set.
`boolean`	`isRange()` Returns whether the protocol includes a range of versions (but not an entire major version range), for example 1.7-1.7.5.
`static boolean`	`isRegistered(int version)` Returns whether a protocol with the given protocol version is registered.
`boolean`	`isSnapshot()` Returns whether this represents a snapshot version.
`boolean`	`isVersionWildcard()` Returns whether the protocol includes an entire major version range (for example 1.8.x).
`static ProtocolVersion`	`register(int version, int snapshotVersion, java.lang.String name)`
`static ProtocolVersion`	`register(int version, int snapshotVersion, java.lang.String name, @Nullable VersionRange versionRange)` Registers a protocol version.
`static ProtocolVersion`	`register(int version, java.lang.String name)`
`static ProtocolVersion`	`register(int version, java.lang.String name, @Nullable VersionRange versionRange)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - v1_4_6
```
public static final ProtocolVersion v1_4_6
```
  - v1_5_1
```
public static final ProtocolVersion v1_5_1
```
  - v1_5_2
```
public static final ProtocolVersion v1_5_2
```
  - v_1_6_1
```
public static final ProtocolVersion v_1_6_1
```
  - v_1_6_2
```
public static final ProtocolVersion v_1_6_2
```
  - v_1_6_3
```
public static final ProtocolVersion v_1_6_3
```
  - v_1_6_4
```
public static final ProtocolVersion v_1_6_4
```
  - v1_7_1
```
public static final ProtocolVersion v1_7_1
```
  - v1_7_6
```
public static final ProtocolVersion v1_7_6
```
  - v1_8
```
public static final ProtocolVersion v1_8
```
  - v1_9
```
public static final ProtocolVersion v1_9
```
  - v1_9_1
```
public static final ProtocolVersion v1_9_1
```
  - v1_9_2
```
public static final ProtocolVersion v1_9_2
```
  - v1_9_3
```
public static final ProtocolVersion v1_9_3
```
  - v1_10
```
public static final ProtocolVersion v1_10
```
  - v1_11
```
public static final ProtocolVersion v1_11
```
  - v1_11_1
```
public static final ProtocolVersion v1_11_1
```
  - v1_12
```
public static final ProtocolVersion v1_12
```
  - v1_12_1
```
public static final ProtocolVersion v1_12_1
```
  - v1_12_2
```
public static final ProtocolVersion v1_12_2
```
  - v1_13
```
public static final ProtocolVersion v1_13
```
  - v1_13_1
```
public static final ProtocolVersion v1_13_1
```
  - v1_13_2
```
public static final ProtocolVersion v1_13_2
```
  - v1_14
```
public static final ProtocolVersion v1_14
```
  - v1_14_1
```
public static final ProtocolVersion v1_14_1
```
  - v1_14_2
```
public static final ProtocolVersion v1_14_2
```
  - v1_14_3
```
public static final ProtocolVersion v1_14_3
```
  - v1_14_4
```
public static final ProtocolVersion v1_14_4
```
  - v1_15
```
public static final ProtocolVersion v1_15
```
  - v1_15_1
```
public static final ProtocolVersion v1_15_1
```
  - v1_15_2
```
public static final ProtocolVersion v1_15_2
```
  - v1_16
```
public static final ProtocolVersion v1_16
```
  - v1_16_1
```
public static final ProtocolVersion v1_16_1
```
  - v1_16_2
```
public static final ProtocolVersion v1_16_2
```
  - v1_16_3
```
public static final ProtocolVersion v1_16_3
```
  - v1_16_4
```
public static final ProtocolVersion v1_16_4
```
  - v1_17
```
public static final ProtocolVersion v1_17
```
  - v1_17_1
```
public static final ProtocolVersion v1_17_1
```
  - v1_18
```
public static final ProtocolVersion v1_18
```
  - v1_18_2
```
public static final ProtocolVersion v1_18_2
```
  - v1_19
```
public static final ProtocolVersion v1_19
```
  - v1_19_1
```
public static final ProtocolVersion v1_19_1
```
  - v1_19_3
```
public static final ProtocolVersion v1_19_3
```
  - v1_19_4
```
public static final ProtocolVersion v1_19_4
```
  - v1_20
```
public static final ProtocolVersion v1_20
```
  - v1_20_2
```
public static final ProtocolVersion v1_20_2
```
  - v1_20_3
```
public static final ProtocolVersion v1_20_3
```
  - unknown
```
public static final ProtocolVersion unknown
```
- Constructor Detail
  - ProtocolVersion
```
public ProtocolVersion(int version,
                       java.lang.String name)
```
    Parameters:
    
    version - protocol version
    
    name - version name
  - ProtocolVersion
```
public ProtocolVersion(int version,
                       int snapshotVersion,
                       java.lang.String name,
                       @Nullable VersionRange versionRange)
```
    Parameters:
    
    version - protocol version
    
    snapshotVersion - actual snapshot protocol version, -1 if not a snapshot
    
    name - version name
    
    versionRange - range of versions that are supported by this protocol version, null if not a range
- Method Detail
  - register
```
public static ProtocolVersion register(int version,
                                       java.lang.String name)
```
  - register
```
public static ProtocolVersion register(int version,
                                       int snapshotVersion,
                                       java.lang.String name)
```
  - register
```
public static ProtocolVersion register(int version,
                                       java.lang.String name,
                                       @Nullable VersionRange versionRange)
```
  - register
```
public static ProtocolVersion register(int version,
                                       int snapshotVersion,
                                       java.lang.String name,
                                       @Nullable VersionRange versionRange)
```
    Registers a protocol version.
    
    Parameters:
    
    version - release protocol version
    
    snapshotVersion - snapshot protocol version, or -1 if not a snapshot
    
    name - version name
    
    versionRange - range of versions that are supported by this protocol version, null if not a range
    
    Returns:
    
    registered ProtocolVersion
  - isRegistered
```
public static boolean isRegistered(int version)
```
    Returns whether a protocol with the given protocol version is registered.
    
    Parameters:
    
    version - protocol version
    
    Returns:
    
    true if this protocol version has been registered
  - getProtocol
```
public static @NonNull ProtocolVersion getProtocol(int version)
```
    Returns a ProtocolVersion instance, even if this protocol version has not been registered. See isRegistered(int) berorehand or isKnown().
    
    Parameters:
    
    version - protocol version
    
    Returns:
    
    registered or unknown ProtocolVersion
  - getIndex
```
public static int getIndex(ProtocolVersion version)
```
    Returns the internal index of the stored protocol version.
    
    Parameters:
    
    version - protocol version instance
    
    Returns:
    
    internal index of the stored protocol version
  - getProtocols
```
public static java.util.List<ProtocolVersion> getProtocols()
```
    Returns an immutable list of registered protocol versions.
    
    Returns:
    
    immutable list of registered protocol versions
  - getClosest
```
public static @Nullable ProtocolVersion getClosest(java.lang.String protocol)
```
    Returns the registered protocol version if present, else null. This accepts the actual registered names (like "1.16.4/5") as well as included versions for version ranges and wildcards.
    
    Parameters:
    
    protocol - version name, e.g. "1.16.3"
    
    Returns:
    
    registered protocol version if present, else null
  - getVersion
```
public int getVersion()
```
    Returns the release protocol version.
    
    Returns:
    
    release version
  - getSnapshotVersion
```
public int getSnapshotVersion()
```
    Returns the snapshot protocol version without the snapshot indicator bit if this is a snapshot protocol version.
    
    Returns:
    
    snapshot protocol version without the snapshot indicator bit
    
    Throws:
    
    java.lang.IllegalArgumentException - if the version is not a snapshot version
    
    See Also:
    
    isSnapshot()
  - getFullSnapshotVersion
```
public int getFullSnapshotVersion()
```
    Returns the snapshot protocol version with the snapshot indicator bit if this is a snapshot protocol version.
    
    Returns:
    
    snapshot protocol version with the snapshot indicator bit
    
    Throws:
    
    java.lang.IllegalArgumentException - if the version is not a snapshot version
    
    See Also:
    
    isSnapshot()
  - getOriginalVersion
```
public int getOriginalVersion()
```
    Returns the release version if release, snapshot version (with the snapshot indicator bit) if snapshot.
    
    Returns:
    
    release version if release, snapshot version (with the snapshot indicator bit) if snapshot
  - isKnown
```
public boolean isKnown()
```
    Returns whether the protocol is set. Should only be unknown for unregistered protocols returned by getProtocol(int).
    
    Returns:
    
    true if the protocol is set
  - isRange
```
public boolean isRange()
```
    Returns whether the protocol includes a range of versions (but not an entire major version range), for example 1.7-1.7.5.
    
    Returns:
    
    true if the protocol includes a range of versions
    
    See Also:
    
    getIncludedVersions()
  - getIncludedVersions
```
public java.util.Set<java.lang.String> getIncludedVersions()
```
    Returns an immutable set of all included versions if the protocol is a version range. If the protocol only includes a single Minecraft version or the entire major version as a wildcard (isVersionWildcard()), the set will only contain the string given in getName().
    
    Returns:
    
    immutable set of all included versions if the protocol is a version range
    
    See Also:
    
    isRange()
  - isVersionWildcard
```
public boolean isVersionWildcard()
```
    Returns whether the protocol includes an entire major version range (for example 1.8.x).
    
    Returns:
    
    true if the protocol includes an entire major version range
  - getName
```
public java.lang.String getName()
```
    Returns the version name.
    
    Returns:
    
    version name
  - isSnapshot
```
public boolean isSnapshot()
```
    Returns whether this represents a snapshot version.
    
    Returns:
    
    true if this represents a snapshot version, false otherwise
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class ProtocolVersion

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

v1_4_6

v1_5_1

v1_5_2

v_1_6_1

v_1_6_2

v_1_6_3

v_1_6_4

v1_7_1

v1_7_6

v1_8

v1_9

v1_9_1

v1_9_2

v1_9_3

v1_10

v1_11

v1_11_1

v1_12

v1_12_1

v1_12_2

v1_13

v1_13_1

v1_13_2

v1_14

v1_14_1

v1_14_2

v1_14_3

v1_14_4

v1_15

v1_15_1

v1_15_2

v1_16

v1_16_1

v1_16_2

v1_16_3

v1_16_4

v1_17

v1_17_1

v1_18

v1_18_2

v1_19

v1_19_1

v1_19_3

v1_19_4

v1_20

v1_20_2

v1_20_3

unknown

Constructor Detail

ProtocolVersion

ProtocolVersion

Method Detail

register

register

register

register

isRegistered

getProtocol

getIndex

getProtocols

getClosest

getVersion

getSnapshotVersion

getFullSnapshotVersion

getOriginalVersion

isKnown

isRange

getIncludedVersions

isVersionWildcard

getName

isSnapshot

equals

hashCode

toString