com.canoo.dolphin.server.event.Topic Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dolphin-platform-server Show documentation

The Dolphin Platform is a framework that implements the presentation model pattern and provides amodern way to create enterprise applications. The Platform provides several client implementations that all canbe used in combination with a general sever API.

There is a newer version: 1.0.0.CR5

Show newest version

/*
 * Copyright 2015-2017 Canoo Engineering AG.
 *
 * 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.canoo.dolphin.server.event;

import java.io.Serializable;
import java.util.UUID;

/**
 * This class defines a topic for the {@link DolphinEventBus}. By using the event bus data messages can be send to
 * a specific topic. A topic is defined by it's name that means that each topic needs a unique name.
 * @param  the type of data that can be send to this topic
 */
public class Topic implements Serializable {

    private static final long serialVersionUID = -875992657685501660L;

    private final String name;

    /**
     * Default constructur that uses a {@link UUID} based string for the name of this topic.
     */
    public Topic() {
        this(UUID.randomUUID().toString());
    }

    /**
     * Constructor that creates a topic based on its name. This name must be unique.
     * @param name the name
     */
    public Topic(String name) {
        this.name = name;
    }

    /**
     * Returns the name of the topic
     * @return name of the topic
     */
    public String getName() {
        return name;
    }

    /**
     * Convenience methods that creates a new topic based on the given unique name
     * @param uniqueName the name
     * @param  the type of data that can be send to the created topic
     * @return the topic
     */
    public static  Topic create(String uniqueName) {
        return new Topic<>(uniqueName);
    }

    public static  Topic create() {
        return new Topic<>();
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof Topic)) return false;

        Topic topic = (Topic) o;

        return name != null ? name.equals(topic.name) : topic.name == null;

    }

    @Override
    public int hashCode() {
        return name != null ? name.hashCode() : 0;
    }
}