ServiceInfo.java

Go to the documentation of this file.

// Copyright 2003-2005 Arthur van Hoff, Rick Blair
// Licensed under Apache License version 2.0
// Original license LGPL
package javax.jmdns;

import java.net.Inet4Address;
import java.net.Inet6Address;
import java.net.InetAddress;
import java.util.Enumeration;
import java.util.Map;

import javax.jmdns.impl.ServiceInfoImpl;

public abstract class ServiceInfo implements Cloneable {

    public static final byte[] NO_VALUE = new byte[0];

    public enum Fields {
        Domain,
        Protocol,
        Application,
        Instance,
        Subtype
    }

    public static ServiceInfo create(final String type, final String name, final int port, final String text) {
        return new ServiceInfoImpl(type, name, "", port, 0, 0, false, text);
    }

    public static ServiceInfo create(final String type, final String name, final String subtype, final int port, final String text) {
        return new ServiceInfoImpl(type, name, subtype, port, 0, 0, false, text);
    }

    public static ServiceInfo create(final String type, final String name, final int port, final int weight, final int priority, final String text) {
        return new ServiceInfoImpl(type, name, "", port, weight, priority, false, text);
    }

    public static ServiceInfo create(final String type, final String name, final String subtype, final int port, final int weight, final int priority, final String text) {
        return new ServiceInfoImpl(type, name, subtype, port, weight, priority, false, text);
    }

    public static ServiceInfo create(final String type, final String name, final int port, final int weight, final int priority, final Map<String, ?> props) {
        return new ServiceInfoImpl(type, name, "", port, weight, priority, false, props);
    }

    public static ServiceInfo create(final String type, final String name, final String subtype, final int port, final int weight, final int priority, final Map<String, ?> props) {
        return new ServiceInfoImpl(type, name, subtype, port, weight, priority, false, props);
    }

    public static ServiceInfo create(final String type, final String name, final int port, final int weight, final int priority, final byte[] text) {
        return new ServiceInfoImpl(type, name, "", port, weight, priority, false, text);
    }

    public static ServiceInfo create(final String type, final String name, final String subtype, final int port, final int weight, final int priority, final byte[] text) {
        return new ServiceInfoImpl(type, name, subtype, port, weight, priority, false, text);
    }

    public static ServiceInfo create(final String type, final String name, final int port, final int weight, final int priority, final boolean persistent, final String text) {
        return new ServiceInfoImpl(type, name, "", port, weight, priority, persistent, text);
    }

    public static ServiceInfo create(final String type, final String name, final String subtype, final int port, final int weight, final int priority, final boolean persistent, final String text) {
        return new ServiceInfoImpl(type, name, subtype, port, weight, priority, persistent, text);
    }

    public static ServiceInfo create(final String type, final String name, final int port, final int weight, final int priority, final boolean persistent, final Map<String, ?> props) {
        return new ServiceInfoImpl(type, name, "", port, weight, priority, persistent, props);
    }

    public static ServiceInfo create(final String type, final String name, final String subtype, final int port, final int weight, final int priority, final boolean persistent, final Map<String, ?> props) {
        return new ServiceInfoImpl(type, name, subtype, port, weight, priority, persistent, props);
    }

    public static ServiceInfo create(final String type, final String name, final int port, final int weight, final int priority, final boolean persistent, final byte[] text) {
        return new ServiceInfoImpl(type, name, "", port, weight, priority, persistent, text);
    }

    public static ServiceInfo create(final String type, final String name, final String subtype, final int port, final int weight, final int priority, final boolean persistent, final byte[] text) {
        return new ServiceInfoImpl(type, name, subtype, port, weight, priority, persistent, text);
    }

    public static ServiceInfo create(final Map<Fields, String> qualifiedNameMap, final int port, final int weight, final int priority, final boolean persistent, final Map<String, ?> props) {
        return new ServiceInfoImpl(qualifiedNameMap, port, weight, priority, persistent, props);
    }

    public abstract boolean hasData();

    public abstract String getType();

    public abstract String getTypeWithSubtype();

    public abstract String getName();

    public abstract String getKey();

    public abstract String getQualifiedName();

    public abstract String getServer();

    @Deprecated
    public abstract String getHostAddress();

    public abstract String[] getHostAddresses();

    @Deprecated
    public abstract InetAddress getAddress();

    @Deprecated
    public abstract InetAddress getInetAddress();

    @Deprecated
    public abstract Inet4Address getInet4Address();

    @Deprecated
    public abstract Inet6Address getInet6Address();

    public abstract InetAddress[] getInetAddresses();

    public abstract Inet4Address[] getInet4Addresses();

    public abstract Inet6Address[] getInet6Addresses();

    public abstract int getPort();

    public abstract int getPriority();

    public abstract int getWeight();

    public abstract byte[] getTextBytes();

    @Deprecated
    public abstract String getTextString();

    @Deprecated
    public abstract String getURL();

    public abstract String[] getURLs();

    @Deprecated
    public abstract String getURL(String protocol);

    public abstract String[] getURLs(String protocol);

    public abstract byte[] getPropertyBytes(final String name);

    public abstract String getPropertyString(final String name);

    public abstract Enumeration<String> getPropertyNames();

    public abstract String getNiceTextString();

    public abstract void setText(final byte[] text) throws IllegalStateException;

    public abstract void setText(final Map<String, ?> props) throws IllegalStateException;

    public abstract boolean isPersistent();

    public abstract String getDomain();

    public abstract String getProtocol();

    public abstract String getApplication();

    public abstract String getSubtype();

    public abstract Map<Fields, String> getQualifiedNameMap();

    /*
     * (non-Javadoc)
     * @see java.lang.Object#clone()
     */
    @Override
    public ServiceInfo clone() {
        try {
            return (ServiceInfo) super.clone();
        } catch (CloneNotSupportedException exception) {
            // clone is supported
            return null;
        }
    }

}