org.springframework.data.redis.listener.ChannelTopic Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-data-redis Show documentation
Show all versions of spring-data-redis Show documentation
Spring Data module for Redis
/*
* Copyright 2011-2023 the original author or authors.
*
* 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
*
* https://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 org.springframework.data.redis.listener;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;
/**
* Channel topic implementation (maps to a Redis channel).
*
* @author Costin Leau
* @author Mark Paluch
*/
public class ChannelTopic implements Topic {
private final String channelName;
/**
* Constructs a new {@link ChannelTopic} instance.
*
* @param name must not be {@literal null}.
*/
public ChannelTopic(String name) {
Assert.notNull(name, "Topic name must not be null");
this.channelName = name;
}
/**
* Create a new {@link ChannelTopic} for channel subscriptions.
*
* @param name the channel name, must not be {@literal null} or empty.
* @return the {@link ChannelTopic} for {@code channelName}.
* @since 2.1
*/
public static ChannelTopic of(String name) {
return new ChannelTopic(name);
}
/**
* @return topic name.
*/
@Override
public String getTopic() {
return channelName;
}
@Override
public String toString() {
return channelName;
}
@Override
public boolean equals(@Nullable Object o) {
if (this == o)
return true;
if (o == null || getClass() != o.getClass())
return false;
ChannelTopic that = (ChannelTopic) o;
return ObjectUtils.nullSafeEquals(channelName, that.channelName);
}
@Override
public int hashCode() {
return ObjectUtils.nullSafeHashCode(channelName);
}
}