com.phloc.web.port.INetworkPort Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2006-2015 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.phloc.web.port;

import java.io.Serializable;

import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;

import com.phloc.commons.name.IHasDescription;
import com.phloc.commons.name.IHasName;

/**
 * Interface describing a single network port.
 * 
 * @author Philip Helger
 */
public interface INetworkPort extends IHasName, IHasDescription, Serializable
{
  /**
   * @return The numeric port number
   */
  @Nonnegative
  int getPort ();

  /**
   * @return The underlying network protocol (TCP / UDP)
   */
  @Nonnull
  ENetworkProtocol getProtocol ();

  /**
   * @return Port name
   */
  @Nonnull
  String getName ();

  /**
   * @return Description of this ports usage
   */
  @Nonnull
  String getDescription ();
}