netty Architecture Docs
Home / Class/ HostsFileEntriesProvider Class — netty Architecture

HostsFileEntriesProvider Class — netty Architecture

Architecture documentation for the HostsFileEntriesProvider class in HostsFileEntriesProvider.java from the netty codebase.

Class java

Entity Profile

Dependency Diagram

graph TD
  2141ee3b_a716_31c4_35df_9a4c1d8f5eae["HostsFileEntriesProvider"]
  cbcfc99c_b17c_c5dd_a391_ae0983e567df["HostsFileEntriesProvider.java"]
  2141ee3b_a716_31c4_35df_9a4c1d8f5eae -->|defined in| cbcfc99c_b17c_c5dd_a391_ae0983e567df
  203d367d_a8ad_a6f6_545c_674895adc8d6["Parser()"]
  2141ee3b_a716_31c4_35df_9a4c1d8f5eae -->|method| 203d367d_a8ad_a6f6_545c_674895adc8d6
  4f18a22f_af7d_3226_5264_1558df3c5d96["HostsFileEntriesProvider()"]
  2141ee3b_a716_31c4_35df_9a4c1d8f5eae -->|method| 4f18a22f_af7d_3226_5264_1558df3c5d96
  16526330_890b_468f_3c67_17fae576b2ba["ipv4Entries()"]
  2141ee3b_a716_31c4_35df_9a4c1d8f5eae -->|method| 16526330_890b_468f_3c67_17fae576b2ba
  2724717f_ab7c_8c8e_fa4b_049b3b14cc5c["ipv6Entries()"]
  2141ee3b_a716_31c4_35df_9a4c1d8f5eae -->|method| 2724717f_ab7c_8c8e_fa4b_049b3b14cc5c

Relationship Graph

Source Code

resolver/src/main/java/io/netty/resolver/HostsFileEntriesProvider.java lines 45–307

public final class HostsFileEntriesProvider {

    public interface Parser {

        /**
         * Parses the hosts file at standard OS location using the system default {@link Charset} for decoding.
         *
         * @return a new {@link HostsFileEntriesProvider}
         * @throws IOException file could not be read
         */
        HostsFileEntriesProvider parse() throws IOException;

        /**
         * Parses the hosts file at standard OS location using the given {@link Charset}s one after another until
         * parse something or none is left.
         *
         * @param charsets the {@link Charset}s to try as file encodings when parsing
         * @return a new {@link HostsFileEntriesProvider}
         * @throws IOException file could not be read
         */
        HostsFileEntriesProvider parse(Charset... charsets) throws IOException;

        /**
         * Parses the provided hosts file using the given {@link Charset}s one after another until
         * parse something or none is left. In case {@link Charset}s are not provided,
         * the system default {@link Charset} is used for decoding.
         *
         * @param file the file to be parsed
         * @param charsets the {@link Charset}s to try as file encodings when parsing, in case {@link Charset}s
         * are not provided, the system default {@link Charset} is used for decoding
         * @return a new {@link HostsFileEntriesProvider}
         * @throws IOException file could not be read
         */
        HostsFileEntriesProvider parse(File file, Charset... charsets) throws IOException;

        /**
         * Performs the parsing operation using the provided reader of hosts file format.
         *
         * @param reader the reader of hosts file format
         * @return a new {@link HostsFileEntriesProvider}
         */
        HostsFileEntriesProvider parse(Reader reader) throws IOException;

        /**
         * Parses the hosts file at standard OS location using the system default {@link Charset} for decoding.
         *
         * @return a new {@link HostsFileEntriesProvider}
         */
        HostsFileEntriesProvider parseSilently();

        /**
         * Parses the hosts file at standard OS location using the given {@link Charset}s one after another until
         * parse something or none is left.
         *
         * @param charsets the {@link Charset}s to try as file encodings when parsing
         * @return a new {@link HostsFileEntriesProvider}
         */
        HostsFileEntriesProvider parseSilently(Charset... charsets);

        /**
         * Parses the provided hosts file using the given {@link Charset}s one after another until
         * parse something or none is left. In case {@link Charset}s are not provided,
         * the system default {@link Charset} is used for decoding.
         *
         * @param file the file to be parsed
         * @param charsets the {@link Charset}s to try as file encodings when parsing, in case {@link Charset}s
         * are not provided, the system default {@link Charset} is used for decoding
         * @return a new {@link HostsFileEntriesProvider}
         */
        HostsFileEntriesProvider parseSilently(File file, Charset... charsets);
    }

    /**
     * Creates a parser for {@link HostsFileEntriesProvider}.
     *
     * @return a new {@link HostsFileEntriesProvider.Parser}
     */
    public static Parser parser() {
        return ParserImpl.INSTANCE;
    }

Defined In

Source

Frequently Asked Questions

What is the HostsFileEntriesProvider class?
HostsFileEntriesProvider is a class in the netty codebase, defined in resolver/src/main/java/io/netty/resolver/HostsFileEntriesProvider.java.
Where is HostsFileEntriesProvider defined?
HostsFileEntriesProvider is defined in resolver/src/main/java/io/netty/resolver/HostsFileEntriesProvider.java at line 45.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free