Package com.mohamnag.jstatic.local_server

Record Class ServerArguments

java.lang.Object
java.lang.Record
com.mohamnag.jstatic.local_server.ServerArguments
public record ServerArguments(Path servingDirectory, int port, boolean enableSsl) extends Record
Accepts an argument starting with "--serve" followed by the path of directory that should be served and optionally the port to serve content over.

For example (please ignore the quotes): "--serve"=path/to/dir or "--serve"=path/to/dir:8082

The port will default to 8080 if not provided.

Optionally a third parameter can be set to constant "ssl" to enable SSL with a self-signed certificate on chosen port. For example: "--serve"=path/to/dir::ssl or "--serve"=path/to/dir:8082:ssl

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CLI_ARG_PREFIX_SERVE
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    ServerArguments(Path servingDirectory, int port, boolean enableSsl)
    Creates an instance of a ServerArguments record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static boolean
    canParse(String s)
     
    boolean
    enableSsl()
    Returns the value of the enableSsl record component.
    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.
    static ServerArguments
    parse(String argumentString)
     
    int
    port()
    Returns the value of the port record component.
    Path
    servingDirectory()
    Returns the value of the servingDirectory record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • ServerArguments

      public ServerArguments(Path servingDirectory, int port, boolean enableSsl)
      Creates an instance of a ServerArguments record class.
      Parameters:
      servingDirectory - the value for the servingDirectory record component
      port - the value for the port record component
      enableSsl - the value for the enableSsl record component

  • Method Details

    • canParse

      public static boolean canParse(String s)

    • parse

      public static ServerArguments parse(String argumentString)

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • servingDirectory

      public Path servingDirectory()
      Returns the value of the servingDirectory record component.
      Returns:
      the value of the servingDirectory record component

    • port

      public int port()
      Returns the value of the port record component.
      Returns:
      the value of the port record component

    • enableSsl

      public boolean enableSsl()
      Returns the value of the enableSsl record component.
      Returns:
      the value of the enableSsl record component