ganymede.notebook.AnnotatedMagic Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ganymede-notebook Show documentation

Ganymede Notebook API and JShell Application

The newest version!

package ganymede.notebook;
/*-
 * ##########################################################################
 * Ganymede
 * %%
 * Copyright (C) 2021, 2022 Allen D. Ball
 * %%
 * 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.
 * ##########################################################################
 */

/**
 * {@link Magic} annotation services.
 *
 * @author {@link.uri mailto:[email protected] Allen D. Ball}
 */
public interface AnnotatedMagic extends Magic {
    @Override
    default String[] getMagicNames() {
        var annotation = getClass().getAnnotation(MagicNames.class);
        var value = (annotation != null) ? annotation.value() : null;

        if (value == null || value.length == 0) {
            value = new String[] { getClass().getSimpleName().toLowerCase() };
        }

        return value;
    }

    @Override
    default String getDescription() {
        var annotation = getClass().getAnnotation(Description.class);
        var value = (annotation != null) ? annotation.value() : null;

        if (value == null) {
            value = "Description not available";
        }

        return value;
    }

    @Override
    default String getUsage() {
        var annotation = getClass().getAnnotation(Usage.class);
        var value = (annotation != null) ? annotation.value() : null;

        return (value != null) ? String.join("\n", value) : null;
    }
}