dev.vankka.mcdiscordreserializer.minecraft.MinecraftSerializerOptions Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of MCDiscordReserializer Show documentation
Show all versions of MCDiscordReserializer Show documentation
A library for transcoding between Minecraft and Discord.
The newest version!
/*
* MCDiscordReserializer: A library for transcoding between Minecraft and Discord.
* Copyright (C) 2018-2021 Vankka
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see the type of the result produced with the renderers
*/
@RequiredArgsConstructor
@ToString
public class MinecraftSerializerOptions {
/**
* Creates the default {@link MinecraftSerializerOptions} for serialization.
* @return the default {@link MinecraftSerializerOptions}.
*/
public static MinecraftSerializerOptions defaults() {
return new MinecraftSerializerOptions<>(new Parser<>(),
DiscordMarkdownRules.createAllRulesForDiscord(true),
Collections.emptyList(),
false);
}
/**
* Creates the default {@link MinecraftSerializerOptions} for escaping markdown.
* @return the default {@link MinecraftSerializerOptions}.
*/
public static MinecraftSerializerOptions escapeDefaults() {
List, Object>> rules = new ArrayList<>();
rules.addAll(SimpleMarkdownRules.createSimpleMarkdownRules(false));
rules.addAll(DiscordMarkdownRules.createStyleRules());
rules.add(SimpleMarkdownRules.createTextRule());
return new MinecraftSerializerOptions<>(new Parser<>(),
rules,
Collections.emptyList(),
false);
}
/**
* Creates a instance of {@link dev.vankka.mcdiscordreserializer.minecraft.MinecraftSerializerOptions}
* with the given renderer added.
*
* @param renderer the renderer to add
* @return the new instance of options
* @throws java.lang.IllegalArgumentException if the renderer is already included in this options instance
* or is of type {@link dev.vankka.mcdiscordreserializer.renderer.implementation.DefaultMinecraftRenderer}
* @see List#add(Object)
*/
public MinecraftSerializerOptions addRenderer(NodeRenderer renderer) {
if (renderers.contains(renderer)) {
throw new IllegalArgumentException("The provided renderer is already included in this options instance");
}
if (renderer.getClass().equals(DefaultMinecraftRenderer.class)) {
throw new IllegalArgumentException("DefaultMinecraftRenderer cannot be added to serializer options");
}
List> renderers = new ArrayList<>(this.renderers);
renderers.add(renderer);
return new MinecraftSerializerOptions<>(parser, rules, renderers, debuggingEnabled);
}
/**
* Creates a instance of {@link dev.vankka.mcdiscordreserializer.minecraft.MinecraftSerializerOptions}
* with the given renderer added at the given index, keep in mind a default renderer is always present.
*
* @param renderer the renderer to add
* @param index the index to add the renderer at
* @return the new instance of options
* @throws java.lang.IllegalArgumentException if the renderer is already included in this options instance
* or is of type {@link dev.vankka.mcdiscordreserializer.renderer.implementation.DefaultMinecraftRenderer}
* @see List#add(int, Object)
*/
public MinecraftSerializerOptions addRenderer(int index, NodeRenderer renderer) {
if (renderers.contains(renderer)) {
throw new IllegalArgumentException("The provided renderer is already included in this options instance");
}
if (renderer.getClass().equals(DefaultMinecraftRenderer.class)) {
throw new IllegalArgumentException("DefaultMinecraftRenderer cannot be added to serializer options");
}
List> renderers = new ArrayList<>(this.renderers);
renderers.add(index, renderer);
return new MinecraftSerializerOptions<>(parser, rules, renderers, debuggingEnabled);
}
/**
* Creates a instance of {@link dev.vankka.mcdiscordreserializer.minecraft.MinecraftSerializerOptions}
* without the given renderer.
*
* @param renderer the renderer to remove
* @return the new instance of options
* @throws java.lang.IllegalArgumentException if the renderer is not included in this options instance
*/
public MinecraftSerializerOptions removeRenderer(NodeRenderer renderer) {
if (!renderers.contains(renderer)) {
throw new IllegalArgumentException("The provided renderer is not included in this options instance");
}
List> renderers = new ArrayList<>(this.renderers);
renderers.remove(renderer);
return new MinecraftSerializerOptions<>(parser, rules, renderers, debuggingEnabled);
}
/**
* Returns the renderers for this options instance.
* @return the ordered unmodifiable list of
*/
public List> getRenderers() {
return Collections.unmodifiableList(renderers);
}
/**
* The SimpleAST {@link Parser} to use to generate the abstract syntax tree.
*/
@NonNull
@With
@Getter
private final Parser, Object> parser;
/**
* The {@link dev.vankka.simpleast.core.parser.Rule Rules} for the {@link Parser},
* {@code null} to use the {@link Parser Parsers} default rules.
*/
@With
@Getter
private final List, Object>> rules;
/**
* The {@link dev.vankka.mcdiscordreserializer.renderer.NodeRenderer}s to use to render formatting for Minecraft.
*/
@NonNull
private final List> renderers;
/**
* Weather or not to use debug logging for the {@link Parser}.
*/
@With
@Getter
private final boolean debuggingEnabled;
}