How to use

IdentifierRule

in

org.apache.openjpa.lib.identifier

public boolean requiresDelimiters(IdentifierConfiguration config, IdentifierRule rule, String name) {
  if (rule == null) {
    throw new IllegalArgumentException(_loc.get("no-rules-provided").getMessage());
  }
  if (rule.getCanDelimit() && !isDelimited(config, rule, name) && rule.requiresDelimiters(name)) {
    return true;
  }
  return false;
}

if (getMustDelimit()) {
  return true;
if (isMustBeginWithLetter()) {
  if (!Character.isJavaIdentifierStart(chars[0])) {
    return true;
  if (isOnlyLettersDigitsUnderscores()) {
    if (!Character.isJavaIdentifierPart(ch) && !(ch == UNDERSCORE)) {
      return true;
  if (StringUtil.contains(getSpecialCharacters(), ch)) {
    return true;
if (getDelimitReservedWords()) {
  if (isReservedWord(identifier)) {
    return true;

/**
 * Returns whether a name is considered a reserved word.
 */
public boolean isReservedWord(IdentifierRule rule, String name) {
  if (rule == null) {
    throw new IllegalArgumentException("Naming rule is null!");
  }
  if (rule.getReservedWords() == null) {
    return false;
  }
  if (!isDelimited(rule, name)) {
    name = name.toUpperCase(Locale.ENGLISH);
  }
  return rule.getReservedWords().contains(name);
}

/**
 * Converts the identifier to a format appropriate for the configuration using
 * the default naming rule.
 * @param delimit If false, do not delimit.  Otherwise, delimit if necessary.
 */
public String toDBName(String name, boolean delimit) {
  return toDBName(getIdentifierConfiguration().getDefaultIdentifierRule().getName(), name, delimit);
}

private int getMaxLen(String rule, DBIdentifier name, int maxLen) {
  IdentifierConfiguration config = getIdentifierConfiguration();
  if (maxLen < 1) {
    IdentifierRule nrule = config.getIdentifierRule(rule);
    maxLen = nrule.getMaxLength();
  }
  // Subtract delimiter length if name is delimited or will be delimited
  if (config.delimitAll() || name.isDelimited()) {
    maxLen = maxLen - (config.getLeadingDelimiter().length() + config.getTrailingDelimiter().length());
  }
  
  return maxLen;
}

public String delimit(IdentifierConfiguration config, IdentifierRule rule, String name, boolean force) {
  if (!rule.getCanDelimit() || StringUtils.isEmpty(name)) {
    return name;
  }
  if ((force && !isDelimited(config, rule, name)) || requiresDelimiters(config, rule, name)) {
    return config.getLeadingDelimiter() + name + config.getTrailingDelimiter();
  }
  return name;
}

/**
 * Converts the identifier to a format appropriate for the configuration using
 * the default naming rule.
 * @param delimit If false, do not delimit.  Otherwise, delimit if necessary.
 */
public String toDBName(String name, boolean delimit) {
  return toDBName(getIdentifierConfiguration().getDefaultIdentifierRule().getName(), name, delimit);
}

private int getMaxLen(String rule, DBIdentifier name, int maxLen) {
  IdentifierConfiguration config = getIdentifierConfiguration();
  if (maxLen < 1) {
    IdentifierRule nrule = config.getIdentifierRule(rule);
    maxLen = nrule.getMaxLength();
  }
  // Subtract delimiter length if name is delimited or will be delimited
  if (config.delimitAll() || name.isDelimited()) {
    maxLen = maxLen - (config.getLeadingDelimiter().length() + config.getTrailingDelimiter().length());
  }
  
  return maxLen;
}

public String delimit(IdentifierConfiguration config, IdentifierRule rule, String name, boolean force) {
  if (!rule.getCanDelimit() || StringUtil.isEmpty(name)) {
    return name;
  }
  if ((force && !isDelimited(config, rule, name)) || requiresDelimiters(config, rule, name)) {
    return config.getLeadingDelimiter() + name + config.getTrailingDelimiter();
  }
  return name;
}

if (getMustDelimit()) {
  return true;
if (isMustBeginWithLetter()) {
  if (!Character.isJavaIdentifierStart(chars[0])) {
    return true;
  if (isOnlyLettersDigitsUnderscores()) {
    if (!Character.isJavaIdentifierPart(ch) && !(ch == UNDERSCORE)) {
      return true;
  if (StringUtil.contains(getSpecialCharacters(), ch)) {
    return true;
if (getDelimitReservedWords()) {
  if (isReservedWord(identifier)) {
    return true;

public boolean requiresDelimiters(IdentifierConfiguration config, IdentifierRule rule, String name) {
  if (rule == null) {
    throw new IllegalArgumentException(_loc.get("no-rules-provided").getMessage());
  }
  if (rule.getCanDelimit() && !isDelimited(config, rule, name) && rule.requiresDelimiters(name)) {
    return true;
  }
  return false;
}

/**
 * Converts the identifier to a format appropriate for the configuration using
 * the default naming rule.
 * @param delimit If false, do not delimit.  Otherwise, delimit if necessary.
 */
public String toDBName(String name, boolean delimit) {
  return toDBName(getIdentifierConfiguration().getDefaultIdentifierRule().getName(), name, delimit);
}

private int getMaxLen(String rule, DBIdentifier name, int maxLen) {
  IdentifierConfiguration config = getIdentifierConfiguration();
  if (maxLen < 1) {
    IdentifierRule nrule = config.getIdentifierRule(rule);
    maxLen = nrule.getMaxLength();
  }
  // Subtract delimiter length if name is delimited or will be delimited
  if (config.delimitAll() || name.isDelimited()) {
    maxLen = maxLen - (config.getLeadingDelimiter().length() + config.getTrailingDelimiter().length());
  }
  
  return maxLen;
}

public String delimit(IdentifierConfiguration config, IdentifierRule rule, String name, boolean force) {
  if (!rule.getCanDelimit() || StringUtil.isEmpty(name)) {
    return name;
  }
  if ((force && !isDelimited(config, rule, name)) || requiresDelimiters(config, rule, name)) {
    return config.getLeadingDelimiter() + name + config.getTrailingDelimiter();
  }
  return name;
}

/**
 * Returns whether a name is considered a reserved word.
 */
public boolean isReservedWord(IdentifierRule rule, String name) {
  if (rule == null) {
    throw new IllegalArgumentException("Naming rule is null!");
  }
  if (rule.getReservedWords() == null) {
    return false;
  }
  if (!isDelimited(rule, name)) {
    name = name.toUpperCase(Locale.ENGLISH);
  }
  return rule.getReservedWords().contains(name);
}

if (getMustDelimit()) {
  return true;
if (isMustBeginWithLetter()) {
  if (!CharUtils.isAsciiAlpha(chars[0])) {
    return true;
  if (isOnlyLettersDigitsUnderscores()) {
    if (!CharUtils.isAsciiAlphanumeric(ch) && !(ch == UNDERSCORE)) {
      return true;
  if (StringUtils.contains(getSpecialCharacters(), ch)) {
    return true;
if (getDelimitReservedWords()) {
  if (isReservedWord(identifier)) {
    return true;

public boolean requiresDelimiters(IdentifierConfiguration config, IdentifierRule rule, String name) {
  if (rule == null) {
    throw new IllegalArgumentException(_loc.get("no-rules-provided").getMessage());
  }
  if (rule.getCanDelimit() && !isDelimited(config, rule, name) && rule.requiresDelimiters(name)) {
    return true;
  }
  return false;
}

/**
 * Converts the identifier to a format appropriate for the configuration using
 * the default naming rule.
 * @param delimit If false, do not delimit.  Otherwise, delimit if necessary.
 */
public String toDBName(String name, boolean delimit) {
  return toDBName(getIdentifierConfiguration().getDefaultIdentifierRule().getName(), name, delimit);
}

private int getMaxLen(String rule, DBIdentifier name, int maxLen) {
  IdentifierConfiguration config = getIdentifierConfiguration();
  if (maxLen < 1) {
    IdentifierRule nrule = config.getIdentifierRule(rule);
    maxLen = nrule.getMaxLength();
  }
  // Subtract delimiter length if name is delimited or will be delimited
  if (config.delimitAll() || name.isDelimited()) {
    maxLen = maxLen - (config.getLeadingDelimiter().length() + config.getTrailingDelimiter().length());
  }
  
  return maxLen;
}

/**
 * Returns whether a name is considered a reserved word.
 */
public boolean isReservedWord(IdentifierRule rule, String name) {
  if (rule == null) {
    throw new IllegalArgumentException("Naming rule is null!");
  }
  if (rule.getReservedWords() == null) {
    return false;
  }
  if (!isDelimited(rule, name)) {
    name = name.toUpperCase();
  }
  return rule.getReservedWords().contains(name);
}