Class URIGenerator
java.lang.Object
org.instancio.internal.generator.AbstractGenerator<T>
org.instancio.internal.generator.net.URIGenerator
- All Implemented Interfaces:
AsStringGeneratorSpec<URI>
,Generator<URI>
,GeneratorSpec<URI>
,AsGeneratorSpec<URI>
,NullableGeneratorSpec<URI>
,URIAsGeneratorSpec
,URIGeneratorSpec
,URISpec
,ValueSpec<URI>
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns the public API method name of the generator spec.Specifies a generator for the fragmentGenerator.Specifies a generator for the host name.nullable()
Indicates thatnull
value can be generated.Specifies a generator for the path.port
(int port) Specifies the port number.Specifies a generator for the query.Specifies that a random port number between 1 and 65535 (inclusive) should be generated.Generate a random scheme from the given choices.protected URI
tryGenerateNonNull
(Random random) Makes the best effort to return a non-null value.Specifies username.Methods inherited from class org.instancio.internal.generator.AbstractGenerator
generate, getContext, hints, isNullable, nullable
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.instancio.generator.specs.AsGeneratorSpec
as, asString
Methods inherited from interface org.instancio.generator.AsStringGeneratorSpec
asString
-
Constructor Details
-
URIGenerator
public URIGenerator() -
URIGenerator
-
-
Method Details
-
apiMethod
Description copied from class:AbstractGenerator
Returns the public API method name of the generator spec. The returned name is used for reporting validation errors.- Specified by:
apiMethod
in classAbstractGenerator<URI>
- Returns:
- spec name if defined, or
null
otherwise
-
scheme
Description copied from interface:URIGeneratorSpec
Generate a random scheme from the given choices. If not specified, the default is HTTP.- Specified by:
scheme
in interfaceURIAsGeneratorSpec
- Specified by:
scheme
in interfaceURIGeneratorSpec
- Specified by:
scheme
in interfaceURISpec
- Parameters:
schemes
- one or more values from which a random scheme will be selected- Returns:
- spec builder
-
userInfo
Description copied from interface:URIGeneratorSpec
Specifies username. If not specified, anull
user will be generated.- Specified by:
userInfo
in interfaceURIAsGeneratorSpec
- Specified by:
userInfo
in interfaceURIGeneratorSpec
- Specified by:
userInfo
in interfaceURISpec
- Parameters:
userInfo
- username to generate- Returns:
- spec builder
-
host
Description copied from interface:URIGeneratorSpec
Specifies a generator for the host name. If not specified, a random host name will be generated.- Specified by:
host
in interfaceURIAsGeneratorSpec
- Specified by:
host
in interfaceURIGeneratorSpec
- Specified by:
host
in interfaceURISpec
- Parameters:
hostGenerator
- generator for the host name- Returns:
- spec builder
-
port
Description copied from interface:URIGeneratorSpec
Specifies the port number. If not specified, default port-1
will be used.- Specified by:
port
in interfaceURIAsGeneratorSpec
- Specified by:
port
in interfaceURIGeneratorSpec
- Specified by:
port
in interfaceURISpec
- Parameters:
port
- port number to use- Returns:
- spec builder
-
randomPort
Description copied from interface:URIGeneratorSpec
Specifies that a random port number between 1 and 65535 (inclusive) should be generated.- Specified by:
randomPort
in interfaceURIAsGeneratorSpec
- Specified by:
randomPort
in interfaceURIGeneratorSpec
- Specified by:
randomPort
in interfaceURISpec
- Returns:
- spec builder
-
path
Description copied from interface:URIGeneratorSpec
Specifies a generator for the path. If not specified,null
path will be generated.- Specified by:
path
in interfaceURIAsGeneratorSpec
- Specified by:
path
in interfaceURIGeneratorSpec
- Specified by:
path
in interfaceURISpec
- Parameters:
path
- generator for the path- Returns:
- spec builder
-
query
Description copied from interface:URIGeneratorSpec
Specifies a generator for the query. If not specified,null
query will be generated.- Specified by:
query
in interfaceURIAsGeneratorSpec
- Specified by:
query
in interfaceURIGeneratorSpec
- Specified by:
query
in interfaceURISpec
- Parameters:
queryGenerator
- generator for the query- Returns:
- spec builder
-
fragment
Description copied from interface:URIGeneratorSpec
Specifies a generator for the fragmentGenerator. If not specified,null
fragmentGenerator will be generated.- Specified by:
fragment
in interfaceURIAsGeneratorSpec
- Specified by:
fragment
in interfaceURIGeneratorSpec
- Specified by:
fragment
in interfaceURISpec
- Parameters:
fragmentGenerator
- generator for the fragment- Returns:
- spec builder
-
nullable
Description copied from interface:NullableGeneratorSpec
Indicates thatnull
value can be generated. -
tryGenerateNonNull
Description copied from class:AbstractGenerator
Makes the best effort to return a non-null value. However, in certain cases this method will produce anull
.- Specified by:
tryGenerateNonNull
in classAbstractGenerator<URI>
- Parameters:
random
- for generating the value- Returns:
- generated value, either a null or non-null
-