Home | History | Annotate | Download | only in net
      1 /*
      2  * Copyright (c) 2007, 2013, Oracle and/or its affiliates. All rights reserved.
      3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
      4  *
      5  * This code is free software; you can redistribute it and/or modify it
      6  * under the terms of the GNU General Public License version 2 only, as
      7  * published by the Free Software Foundation.  Oracle designates this
      8  * particular file as subject to the "Classpath" exception as provided
      9  * by Oracle in the LICENSE file that accompanied this code.
     10  *
     11  * This code is distributed in the hope that it will be useful, but WITHOUT
     12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
     13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
     14  * version 2 for more details (a copy is included in the LICENSE file that
     15  * accompanied this code).
     16  *
     17  * You should have received a copy of the GNU General Public License version
     18  * 2 along with this work; if not, write to the Free Software Foundation,
     19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
     20  *
     21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
     22  * or visit www.oracle.com if you need additional information or have any
     23  * questions.
     24  */
     25 
     26 package java.net;
     27 
     28 /**
     29  * A socket option associated with a socket.
     30  *
     31  * <p> In the {@link java.nio.channels channels} package, the {@link
     32  * java.nio.channels.NetworkChannel} interface defines the {@link
     33  * java.nio.channels.NetworkChannel#setOption(SocketOption,Object) setOption}
     34  * and {@link java.nio.channels.NetworkChannel#getOption(SocketOption) getOption}
     35  * methods to set and query the channel's socket options.
     36  *
     37  * @param   <T>     The type of the socket option value.
     38  *
     39  * @since 1.7
     40  *
     41  * @see StandardSocketOptions
     42  */
     43 
     44 public interface SocketOption<T> {
     45 
     46     /**
     47      * Returns the name of the socket option.
     48      *
     49      * @return the name of the socket option
     50      */
     51     String name();
     52 
     53     /**
     54      * Returns the type of the socket option value.
     55      *
     56      * @return the type of the socket option value
     57      */
     58     Class<T> type();
     59 }
     60