EndpointInfo (Armeria 1.8.0 API reference)

java.lang.Object

com.linecorp.armeria.server.docs.EndpointInfo

@UnstableApi
public final class EndpointInfo
extends Object

Metadata about the endpoints exposed by a Service.

Method Summary

Modifier and Type	Method	Description
`Set<MediaType>`	`availableMimeTypes()`	Returns the set of available MIME types of this endpoint.
`static EndpointInfoBuilder`	`builder(String hostnamePattern, String pathMapping)`	Returns a newly created `EndpointInfoBuilder` that builds the `EndpointInfo` with the specified `hostnamePattern` and `pathMapping`.
`MediaType`	`defaultMimeType()`	Returns the default MIME type of this endpoint.
`boolean`	`equals(Object obj)`
`String`	`fragment()`	Returns the URI fragment of this endpoint.
`int`	`hashCode()`
`String`	`hostnamePattern()`	Returns the hostname pattern of this endpoint.
`String`	`pathMapping()`	Returns the path mapping of this endpoint.
`String`	`regexPathPrefix()`	Returns the prefix of this endpoint if the `pathMapping()` returns a regular expression string of endpoint and the prefix exists, otherwise `null`.
`String`	`toString()`

Methods inherited from class java.lang.Object

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

Method Details
- builder
  
  public static EndpointInfoBuilder builder(String hostnamePattern, String pathMapping)
  
  Returns a newly created EndpointInfoBuilder that builds the EndpointInfo with the specified hostnamePattern and pathMapping.
- hostnamePattern
  
  public String hostnamePattern()
  
  Returns the hostname pattern of this endpoint.
- pathMapping
  
  public String pathMapping()
  
  Returns the path mapping of this endpoint.
- regexPathPrefix
  
  @Nullable public String regexPathPrefix()
  
  Returns the prefix of this endpoint if the pathMapping() returns a regular expression string of endpoint and the prefix exists, otherwise null.
- fragment
  
  @Nullable public String fragment()
  
  Returns the URI fragment of this endpoint.
- defaultMimeType
  
  @Nullable public MediaType defaultMimeType()
  
  Returns the default MIME type of this endpoint.
- availableMimeTypes
  
  public Set<MediaType> availableMimeTypes()
  
  Returns the set of available MIME types of this endpoint.
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- equals
  
  public boolean equals(@Nullable Object obj)
  
  Overrides:
  
  equals in class Object
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object