Package io.spine.net
Class Uri
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- io.spine.net.Uri
-
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,UriOrBuilder
,io.spine.validate.ValidatableMessage
,Serializable
public final class Uri extends com.google.protobuf.GeneratedMessageV3 implements io.spine.validate.ValidatableMessage, UriOrBuilder
A URL in a structured form. This type represents URL according to RFC 3986. Using this type makes it easier to operate concrete URL attributes. Please see https://tools.ietf.org/html/rfc3986. This type is intended to be used only by parsing or validating utilities. For general purpose usage, please use `Url`.
Protobuf typespine.net.Uri
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Uri.Authorization
Pair of the username (email commonly) and password (optional) (e.g.static interface
Uri.AuthorizationOrBuilder
static class
Uri.Builder
A URL in a structured form.static class
Uri.Protocol
Application layer protocol.static interface
Uri.ProtocolOrBuilder
static class
Uri.QueryParameter
Url query parameter type.static interface
Uri.QueryParameterOrBuilder
static class
Uri.Schema
Most often used application layer protocols.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static int
AUTH_FIELD_NUMBER
static int
FRAGMENT_FIELD_NUMBER
static int
HOST_FIELD_NUMBER
static int
PATH_FIELD_NUMBER
static int
PORT_FIELD_NUMBER
static int
PROTOCOL_FIELD_NUMBER
static int
QUERY_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
Uri.Authorization
getAuth()
User's email and password (both optional).Uri.AuthorizationOrBuilder
getAuthOrBuilder()
User's email and password (both optional).static Uri
getDefaultInstance()
Uri
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
String
getFragment()
Sub-resource (e.g.com.google.protobuf.ByteString
getFragmentBytes()
Sub-resource (e.g.String
getHost()
Domain name.com.google.protobuf.ByteString
getHostBytes()
Domain name.com.google.protobuf.Parser<Uri>
getParserForType()
String
getPath()
Relative path to desired resource (e.g.com.google.protobuf.ByteString
getPathBytes()
Relative path to desired resource (e.g.String
getPort()
Server's port (e.g.com.google.protobuf.ByteString
getPortBytes()
Server's port (e.g.Uri.Protocol
getProtocol()
Application layer protocol.Uri.ProtocolOrBuilder
getProtocolOrBuilder()
Application layer protocol.Uri.QueryParameter
getQuery(int index)
A list of key-value pairs (?key1=value1&key2=value2).int
getQueryCount()
A list of key-value pairs (?key1=value1&key2=value2).List<Uri.QueryParameter>
getQueryList()
A list of key-value pairs (?key1=value1&key2=value2).Uri.QueryParameterOrBuilder
getQueryOrBuilder(int index)
A list of key-value pairs (?key1=value1&key2=value2).List<? extends Uri.QueryParameterOrBuilder>
getQueryOrBuilderList()
A list of key-value pairs (?key1=value1&key2=value2).int
getSerializedSize()
com.google.protobuf.UnknownFieldSet
getUnknownFields()
boolean
hasAuth()
User's email and password (both optional).int
hashCode()
boolean
hasProtocol()
Application layer protocol.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static Uri.Builder
newBuilder()
static Uri.Builder
newBuilder(Uri prototype)
Uri.Builder
newBuilderForType()
protected Uri.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Uri
parseDelimitedFrom(InputStream input)
static Uri
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Uri
parseFrom(byte[] data)
static Uri
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Uri
parseFrom(com.google.protobuf.ByteString data)
static Uri
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Uri
parseFrom(com.google.protobuf.CodedInputStream input)
static Uri
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Uri
parseFrom(InputStream input)
static Uri
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Uri
parseFrom(ByteBuffer data)
static Uri
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Uri>
parser()
Uri.Builder
toBuilder()
Optional<io.spine.validate.ValidationError>
validate()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
PROTOCOL_FIELD_NUMBER
public static final int PROTOCOL_FIELD_NUMBER
- See Also:
- Constant Field Values
-
AUTH_FIELD_NUMBER
public static final int AUTH_FIELD_NUMBER
- See Also:
- Constant Field Values
-
HOST_FIELD_NUMBER
public static final int HOST_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PORT_FIELD_NUMBER
public static final int PORT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PATH_FIELD_NUMBER
public static final int PATH_FIELD_NUMBER
- See Also:
- Constant Field Values
-
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FRAGMENT_FIELD_NUMBER
public static final int FRAGMENT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
- Specified by:
getUnknownFields
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getUnknownFields
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
hasProtocol
public boolean hasProtocol()
Application layer protocol.
.spine.net.Uri.Protocol protocol = 1;
- Specified by:
hasProtocol
in interfaceUriOrBuilder
- Returns:
- Whether the protocol field is set.
-
getProtocol
public Uri.Protocol getProtocol()
Application layer protocol.
.spine.net.Uri.Protocol protocol = 1;
- Specified by:
getProtocol
in interfaceUriOrBuilder
- Returns:
- The protocol.
-
getProtocolOrBuilder
public Uri.ProtocolOrBuilder getProtocolOrBuilder()
Application layer protocol.
.spine.net.Uri.Protocol protocol = 1;
- Specified by:
getProtocolOrBuilder
in interfaceUriOrBuilder
-
hasAuth
public boolean hasAuth()
User's email and password (both optional).
.spine.net.Uri.Authorization auth = 2 [(.required) = false, (.validate) = true];
- Specified by:
hasAuth
in interfaceUriOrBuilder
- Returns:
- Whether the auth field is set.
-
getAuth
public Uri.Authorization getAuth()
User's email and password (both optional).
.spine.net.Uri.Authorization auth = 2 [(.required) = false, (.validate) = true];
- Specified by:
getAuth
in interfaceUriOrBuilder
- Returns:
- The auth.
-
getAuthOrBuilder
public Uri.AuthorizationOrBuilder getAuthOrBuilder()
User's email and password (both optional).
.spine.net.Uri.Authorization auth = 2 [(.required) = false, (.validate) = true];
- Specified by:
getAuthOrBuilder
in interfaceUriOrBuilder
-
getHost
public String getHost()
Domain name.
string host = 3;
- Specified by:
getHost
in interfaceUriOrBuilder
- Returns:
- The host.
-
getHostBytes
public com.google.protobuf.ByteString getHostBytes()
Domain name.
string host = 3;
- Specified by:
getHostBytes
in interfaceUriOrBuilder
- Returns:
- The bytes for host.
-
getPort
public String getPort()
Server's port (e.g. :8080). We leave port as string, because port 0 is hypothetically possible to use.
string port = 4;
- Specified by:
getPort
in interfaceUriOrBuilder
- Returns:
- The port.
-
getPortBytes
public com.google.protobuf.ByteString getPortBytes()
Server's port (e.g. :8080). We leave port as string, because port 0 is hypothetically possible to use.
string port = 4;
- Specified by:
getPortBytes
in interfaceUriOrBuilder
- Returns:
- The bytes for port.
-
getPath
public String getPath()
Relative path to desired resource (e.g. "/index" or "/js/app.js").
string path = 5;
- Specified by:
getPath
in interfaceUriOrBuilder
- Returns:
- The path.
-
getPathBytes
public com.google.protobuf.ByteString getPathBytes()
Relative path to desired resource (e.g. "/index" or "/js/app.js").
string path = 5;
- Specified by:
getPathBytes
in interfaceUriOrBuilder
- Returns:
- The bytes for path.
-
getQueryList
public List<Uri.QueryParameter> getQueryList()
A list of key-value pairs (?key1=value1&key2=value2).
repeated .spine.net.Uri.QueryParameter query = 6;
- Specified by:
getQueryList
in interfaceUriOrBuilder
-
getQueryOrBuilderList
public List<? extends Uri.QueryParameterOrBuilder> getQueryOrBuilderList()
A list of key-value pairs (?key1=value1&key2=value2).
repeated .spine.net.Uri.QueryParameter query = 6;
- Specified by:
getQueryOrBuilderList
in interfaceUriOrBuilder
-
getQueryCount
public int getQueryCount()
A list of key-value pairs (?key1=value1&key2=value2).
repeated .spine.net.Uri.QueryParameter query = 6;
- Specified by:
getQueryCount
in interfaceUriOrBuilder
-
getQuery
public Uri.QueryParameter getQuery(int index)
A list of key-value pairs (?key1=value1&key2=value2).
repeated .spine.net.Uri.QueryParameter query = 6;
- Specified by:
getQuery
in interfaceUriOrBuilder
-
getQueryOrBuilder
public Uri.QueryParameterOrBuilder getQueryOrBuilder(int index)
A list of key-value pairs (?key1=value1&key2=value2).
repeated .spine.net.Uri.QueryParameter query = 6;
- Specified by:
getQueryOrBuilder
in interfaceUriOrBuilder
-
getFragment
public String getFragment()
Sub-resource (e.g. "#article").
string fragment = 7;
- Specified by:
getFragment
in interfaceUriOrBuilder
- Returns:
- The fragment.
-
getFragmentBytes
public com.google.protobuf.ByteString getFragmentBytes()
Sub-resource (e.g. "#article").
string fragment = 7;
- Specified by:
getFragmentBytes
in interfaceUriOrBuilder
- Returns:
- The bytes for fragment.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Uri parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Uri parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Uri parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Uri parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Uri parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Uri parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Uri parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static Uri parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static Uri parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static Uri parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static Uri parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static Uri parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public Uri.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static Uri.Builder newBuilder()
-
newBuilder
public static Uri.Builder newBuilder(Uri prototype)
-
toBuilder
public Uri.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Uri.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
validate
public Optional<io.spine.validate.ValidationError> validate()
- Specified by:
validate
in interfaceio.spine.validate.ValidatableMessage
-
getDefaultInstance
public static Uri getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<Uri> parser()
-
getParserForType
public com.google.protobuf.Parser<Uri> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public Uri getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-