net.dv8tion.jda.api.managers.PermOverrideManager Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of JDA Show documentation
Show all versions of JDA Show documentation
Java wrapper for the popular chat & VOIP service: Discord https://discord.com
/*
* Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
*
* 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 net.dv8tion.jda.api.managers;
import net.dv8tion.jda.api.Permission;
import net.dv8tion.jda.api.entities.Guild;
import net.dv8tion.jda.api.entities.PermissionOverride;
import net.dv8tion.jda.api.entities.channel.attribute.IPermissionContainer;
import net.dv8tion.jda.api.entities.channel.middleman.GuildChannel;
import net.dv8tion.jda.api.entities.channel.unions.IPermissionContainerUnion;
import net.dv8tion.jda.internal.utils.Checks;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
import java.util.Collection;
/**
* Manager providing functionality to update one or more fields for a {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}.
*
* Example
*
{@code
* manager.setDenied(Permission.MESSAGE_SEND)
* .setAllowed(Permission.VIEW_CHANNEL)
* .queue();
* manager.reset(PermOverrideManager.DENIED | PermOverrideManager.ALLOWED)
* .grant(Permission.MESSAGE_SEND)
* .clear(Permission.MESSAGE_MANAGE)
* .queue();
* }
*
* @see net.dv8tion.jda.api.entities.PermissionOverride#getManager()
*/
public interface PermOverrideManager extends Manager
{
/** Used to reset the denied field */
long DENIED = 1;
/** Used to reset the granted field */
long ALLOWED = 1 << 1;
/** Used to reset all permissions to their original value */
long PERMISSIONS = ALLOWED | DENIED;
/**
* Resets the fields specified by the provided bit-flag pattern.
* You can specify a combination by using a bitwise OR concat of the flag constants.
*
Example: {@code manager.reset(PermOverrideManager.ALLOWED | PermOverrideManager.DENIED);}
*
* Flag Constants:
*
* - {@link #DENIED}
* - {@link #ALLOWED}
* - {@link #PERMISSIONS}
*
*
* @param fields
* Integer value containing the flags to reset.
*
* @return PermOverrideManager for chaining convenience
*/
@Nonnull
@Override
PermOverrideManager reset(long fields);
/**
* Resets the fields specified by the provided bit-flag patterns.
*
Example: {@code manager.reset(PermOverrideManager.ALLOWED, PermOverrideManager.DENIED);}
*
* Flag Constants:
*
* - {@link #DENIED}
* - {@link #ALLOWED}
* - {@link #PERMISSIONS}
*
*
* @param fields
* Integer values containing the flags to reset.
*
* @return PermOverrideManager for chaining convenience
*/
@Nonnull
@Override
PermOverrideManager reset(long... fields);
/**
* The {@link net.dv8tion.jda.api.entities.Guild Guild} this Manager's
* {@link GuildChannel GuildChannel} is in.
*
This is logically the same as calling {@code getPermissionOverride().getGuild()}
*
* @return The parent {@link net.dv8tion.jda.api.entities.Guild Guild}
*/
@Nonnull
default Guild getGuild()
{
return getPermissionOverride().getGuild();
}
/**
* The {@link IPermissionContainer GuildChannel} this Manager's
* {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride} is in.
*
This is logically the same as calling {@code getPermissionOverride().getChannel()}
*
* @return The parent {@link GuildChannel GuildChannel}
*/
@Nonnull
default IPermissionContainerUnion getChannel()
{
return getPermissionOverride().getChannel();
}
/**
* The target {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
* that will be modified by this Manager
*
* @return The target {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
*/
@Nonnull
PermissionOverride getPermissionOverride();
/**
* Grants the provided {@link net.dv8tion.jda.api.Permission Permissions} bits
* to the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}.
*
* @param permissions
* The permissions to grant to the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
*
* @return PermOverrideManager for chaining convenience
*/
@Nonnull
@CheckReturnValue
PermOverrideManager grant(long permissions);
/**
* Grants the provided {@link net.dv8tion.jda.api.Permission Permissions}
* to the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}.
*
* @param permissions
* The permissions to grant to the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
*
* @throws IllegalArgumentException
* If any of the provided Permissions is {@code null}
*
* @return PermOverrideManager for chaining convenience
*
* @see net.dv8tion.jda.api.Permission#getRaw(net.dv8tion.jda.api.Permission...) Permission.getRaw(Permission...)
*/
@Nonnull
@CheckReturnValue
default PermOverrideManager grant(@Nonnull Permission... permissions)
{
Checks.notNull(permissions, "Permissions");
return grant(Permission.getRaw(permissions));
}
/**
* Grants the provided {@link net.dv8tion.jda.api.Permission Permissions}
* to the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}.
*
* @param permissions
* The permissions to grant to the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
*
* @throws IllegalArgumentException
* If any of the provided Permissions is {@code null}
*
* @return PermOverrideManager for chaining convenience
*
* @see java.util.EnumSet EnumSet
* @see net.dv8tion.jda.api.Permission#getRaw(java.util.Collection) Permission.getRaw(Collection)
*/
@Nonnull
@CheckReturnValue
default PermOverrideManager grant(@Nonnull Collection permissions)
{
return grant(Permission.getRaw(permissions));
}
/**
* Denies the provided {@link net.dv8tion.jda.api.Permission Permissions} bits
* from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}.
*
* @param permissions
* The permissions to deny from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
*
* @return PermOverrideManager for chaining convenience
*/
@Nonnull
@CheckReturnValue
PermOverrideManager deny(long permissions);
/**
* Denies the provided {@link net.dv8tion.jda.api.Permission Permissions}
* from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}.
*
* @param permissions
* The permissions to deny from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
*
* @throws IllegalArgumentException
* If any of the provided Permissions is {@code null}
*
* @return PermOverrideManager for chaining convenience
*
* @see net.dv8tion.jda.api.Permission#getRaw(net.dv8tion.jda.api.Permission...) Permission.getRaw(Permission...)
*/
@Nonnull
@CheckReturnValue
default PermOverrideManager deny(@Nonnull Permission... permissions)
{
Checks.notNull(permissions, "Permissions");
return deny(Permission.getRaw(permissions));
}
/**
* Denies the provided {@link net.dv8tion.jda.api.Permission Permissions}
* from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}.
*
* @param permissions
* The permissions to deny from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
*
* @throws IllegalArgumentException
* If any of the provided Permissions is {@code null}
*
* @return PermOverrideManager for chaining convenience
*
* @see java.util.EnumSet EnumSet
* @see net.dv8tion.jda.api.Permission#getRaw(java.util.Collection) Permission.getRaw(Collection)
*/
@Nonnull
@CheckReturnValue
default PermOverrideManager deny(@Nonnull Collection permissions)
{
return deny(Permission.getRaw(permissions));
}
/**
* Clears the provided {@link net.dv8tion.jda.api.Permission Permissions} bits
* from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}.
*
This will cause the provided Permissions to be inherited
*
* @param permissions
* The permissions to clear from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
*
* @return PermOverrideManager for chaining convenience
*/
@Nonnull
@CheckReturnValue
PermOverrideManager clear(long permissions);
/**
* Clears the provided {@link net.dv8tion.jda.api.Permission Permissions} bits
* from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}.
*
This will cause the provided Permissions to be inherited
*
* @param permissions
* The permissions to clear from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
*
* @throws IllegalArgumentException
* If any of the provided Permissions is {@code null}
*
* @return PermOverrideManager for chaining convenience
*/
@Nonnull
@CheckReturnValue
default PermOverrideManager clear(@Nonnull Permission... permissions)
{
Checks.notNull(permissions, "Permissions");
return clear(Permission.getRaw(permissions));
}
/**
* Clears the provided {@link net.dv8tion.jda.api.Permission Permissions} bits
* from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}.
*
This will cause the provided Permissions to be inherited
*
* @param permissions
* The permissions to clear from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
*
* @throws IllegalArgumentException
* If any of the provided Permissions is {@code null}
*
* @return PermOverrideManager for chaining convenience
*
* @see java.util.EnumSet EnumSet
* @see net.dv8tion.jda.api.Permission#getRaw(java.util.Collection) Permission.getRaw(Collection)
*/
@Nonnull
@CheckReturnValue
default PermOverrideManager clear(@Nonnull Collection permissions)
{
return clear(Permission.getRaw(permissions));
}
}