001package org.apache.maven.doxia.markup;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022/**
023 * List of constants used by all markup syntax.
024 *
025 * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
026 * @version $Id$
027 * @since 1.0
028 */
029@SuppressWarnings( "checkstyle:interfaceistype" )
030public interface Markup
031{
032    /** The vm line separator */
033    String EOL = System.getProperty( "line.separator" );
034
035    // ----------------------------------------------------------------------
036    // Generic separator characters
037    // ----------------------------------------------------------------------
038
039    /** equal character: '=' */
040    char EQUAL = '=';
041
042    /** end character: '>' */
043    char GREATER_THAN = '>';
044
045    /** left curly bracket character: '{' */
046    char LEFT_CURLY_BRACKET = '{';
047
048    /** left square bracket character: '[' */
049    char LEFT_SQUARE_BRACKET = '[';
050
051    /** start character: '<' */
052    char LESS_THAN = '<';
053
054    /** minus character: '-' */
055    char MINUS = '-';
056
057    /** plus character: '+' */
058    char PLUS = '+';
059
060    /** double quote character: '\"' */
061    char QUOTE = '\"';
062
063    /** right curly bracket character: '}' */
064    char RIGHT_CURLY_BRACKET = '}';
065
066    /** right square bracket character: ']' */
067    char RIGHT_SQUARE_BRACKET = ']';
068
069    /** slash character: '/' */
070    char SLASH = '/';
071
072    /** space character: ' ' */
073    char SPACE = ' ';
074
075    /** star character: '*' */
076    char STAR = '*';
077
078    /** colon character: ':' */
079    char COLON = ':';
080
081    /** semicolon character: ';' */
082    char SEMICOLON = ';';
083}