Smack/smack-experimental/src/main/java/org/jivesoftware/smackx/hints/element/NoPermanentStoreHint.java

70 lines
2.1 KiB
Java

/**
*
* Copyright 2017 Florian Schmaus
*
* 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 org.jivesoftware.smackx.hints.element;
import org.jivesoftware.smack.packet.Message;
/**
* A "no permanent store" hint. Messages with this hint should not be stored in permanent stores or archives.
*
* @see <a href="https://xmpp.org/extensions/xep-0334.html#no-permanent-store">XEP-0334 § 4.1 No permanent store</a>
*/
public final class NoPermanentStoreHint extends MessageProcessingHint {
public static final NoPermanentStoreHint INSTANCE = new NoPermanentStoreHint();
public static final String ELEMENT = "no-permanent-store";
private NoPermanentStoreHint() {
}
@Override
public String getElementName() {
return ELEMENT;
}
@Override
public String toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
return '<' + ELEMENT + " xmlns='" + NAMESPACE + "'/>";
}
@Override
public MessageProcessingHintType getHintType() {
return MessageProcessingHintType.no_permanent_store;
}
public static NoPermanentStoreHint from(Message message) {
return message.getExtension(ELEMENT, NAMESPACE);
}
public static boolean hasHint(Message message) {
return from(message) != null;
}
public static void set(Message message) {
if (StoreHint.hasHint(message)) {
// No need to set the no-permanent-store hint when a no-store hint is already set.
return;
}
message.overrideExtension(INSTANCE);
}
public static void setExplicitly(Message message) {
message.addExtension(INSTANCE);
}
}