blob: 8970fcd9d65668dfed727272a0b4d57fea71d049 [file] [log] [blame]
/*
* Copyright 2000-2010 JetBrains s.r.o.
*
* 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 com.intellij.formatting;
/**
* Is assumed to be a single place to hold various constants to use during formatting.
* <p/>
* Thread-safe.
*
* @author Denis Zhdanov
* @since Sep 14, 2010 2:56:04 PM
*/
public class FormatConstants {
/**
* It may be necessary to wrap a long line sometimes (during formatting, when typing reaches right margin etc). We should take
* into consideration possibility that additional symbols are inserted during that.
* <p/>
* For example consider that we want to wrap long string literal:
* <p/>
* <pre>
* |
* | <- right margin
* "this is a long string to w|rap"
* |
* </pre>
* We can't just wrap before 'w' symbol of 'wrap' word because we can get the following situation then:
* <p/>
* <pre>
* |
* | <- right margin
* "this is a long string to "| + // Notice that '" +' string is inserted at the wrapped line
* "wrap" |
* </pre>
* Hence, we need to reserve particular number of columns.
* <p/>
* This constant is assumed to hold language-agnostic number of columns to reserve on smart line wrapping.
*/
public static final int RESERVED_LINE_WRAP_WIDTH_IN_COLUMNS = 3; // '3' is for breaking string literal: 'quote symbol',
// 'space' and 'plus' operator
private FormatConstants() {
}
}