From 581e6ca2fe6f5d7c6a65b69a1dcf479c41fffbf2 Mon Sep 17 00:00:00 2001 From: "Shawn O. Pearce" Date: Tue, 27 Mar 2012 10:43:02 -0400 Subject: [PATCH] Extract inner classes from Config The Config class is getting very large. Extract two of its inner classes into new top level types to reduce the size of Config. Rename them slightly in the process. Change-Id: I693148a5ae2977378789bf455c880a6fd856c0f0 --- .../src/org/eclipse/jgit/lib/Config.java | 180 ++++-------------- .../src/org/eclipse/jgit/lib/ConfigLine.java | 128 +++++++++++++ .../org/eclipse/jgit/lib/ConfigSnapshot.java | 68 +++++++ 3 files changed, 236 insertions(+), 140 deletions(-) create mode 100644 org.eclipse.jgit/src/org/eclipse/jgit/lib/ConfigLine.java create mode 100644 org.eclipse.jgit/src/org/eclipse/jgit/lib/ConfigSnapshot.java diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/Config.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/Config.java index 7ea91ffaf..cf166d5b9 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/lib/Config.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/Config.java @@ -61,7 +61,6 @@ import java.util.List; import java.util.Map; import java.util.Set; -import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.atomic.AtomicReference; import org.eclipse.jgit.errors.ConfigInvalidException; @@ -91,7 +90,7 @@ public class Config { * This state is copy-on-write. It should always contain an immutable list * of the configuration keys/values. */ - private final AtomicReference state; + private final AtomicReference state; private final Config baseConfig; @@ -118,7 +117,7 @@ public Config() { */ public Config(Config defaultConfig) { baseConfig = defaultConfig; - state = new AtomicReference(newState()); + state = new AtomicReference(newState()); } /** @@ -527,7 +526,7 @@ public Set getNames(String section, String subsection) { */ @SuppressWarnings("unchecked") public T get(final SectionParser parser) { - final State myState = getState(); + final ConfigSnapshot myState = getState(); T obj = (T) myState.cache.get(parser); if (obj == null) { obj = parser.parse(this); @@ -601,7 +600,7 @@ else if (baseConfig != null) private List getRawStringList(final String section, final String subsection, final String name) { List r = null; - for (final Entry e : state.get().entryList) { + for (final ConfigLine e : state.get().entryList) { if (e.match(section, subsection, name)) r = add(r, e.value); } @@ -621,19 +620,19 @@ private static List add(final List curr, final String value) { return curr; } - private State getState() { - State cur, upd; + private ConfigSnapshot getState() { + ConfigSnapshot cur, upd; do { cur = state.get(); - final State base = getBaseState(); + final ConfigSnapshot base = getBaseState(); if (cur.baseState == base) return cur; - upd = new State(cur.entryList, base); + upd = new ConfigSnapshot(cur.entryList, base); } while (!state.compareAndSet(cur, upd)); return upd; } - private State getBaseState() { + private ConfigSnapshot getBaseState() { return baseConfig != null ? baseConfig.getState() : null; } @@ -792,20 +791,21 @@ public void unset(final String section, final String subsection, * optional subsection value, e.g. a branch name */ public void unsetSection(String section, String subsection) { - State src, res; + ConfigSnapshot src, res; do { src = state.get(); res = unsetSection(src, section, subsection); } while (!state.compareAndSet(src, res)); } - private State unsetSection(final State srcState, final String section, + private ConfigSnapshot unsetSection(final ConfigSnapshot srcState, + final String section, final String subsection) { final int max = srcState.entryList.size(); - final ArrayList r = new ArrayList(max); + final ArrayList r = new ArrayList(max); boolean lastWasMatch = false; - for (Entry e : srcState.entryList) { + for (ConfigLine e : srcState.entryList) { if (e.match(section, subsection)) { // Skip this record, it's for the section we are removing. lastWasMatch = true; @@ -839,7 +839,7 @@ private State unsetSection(final State srcState, final String section, */ public void setStringList(final String section, final String subsection, final String name, final List values) { - State src, res; + ConfigSnapshot src, res; do { src = state.get(); res = replaceStringList(src, section, subsection, name, values); @@ -848,10 +848,10 @@ public void setStringList(final String section, final String subsection, fireConfigChangedEvent(); } - private State replaceStringList(final State srcState, + private ConfigSnapshot replaceStringList(final ConfigSnapshot srcState, final String section, final String subsection, final String name, final List values) { - final List entries = copy(srcState, values); + final List entries = copy(srcState, values); int entryIndex = 0; int valueIndex = 0; int insertPosition = -1; @@ -859,7 +859,7 @@ private State replaceStringList(final State srcState, // Reset the first n Entry objects that match this input name. // while (entryIndex < entries.size() && valueIndex < values.size()) { - final Entry e = entries.get(entryIndex); + final ConfigLine e = entries.get(entryIndex); if (e.match(section, subsection, name)) { entries.set(entryIndex, e.forValue(values.get(valueIndex++))); insertPosition = entryIndex + 1; @@ -871,7 +871,7 @@ private State replaceStringList(final State srcState, // if (valueIndex == values.size() && entryIndex < entries.size()) { while (entryIndex < entries.size()) { - final Entry e = entries.get(entryIndex++); + final ConfigLine e = entries.get(entryIndex++); if (e.match(section, subsection, name)) entries.remove(--entryIndex); } @@ -891,14 +891,14 @@ private State replaceStringList(final State srcState, // We didn't find any matching section header for this key, // so we must create a new section header at the end. // - final Entry e = new Entry(); + final ConfigLine e = new ConfigLine(); e.section = section; e.subsection = subsection; entries.add(e); insertPosition = entries.size(); } while (valueIndex < values.size()) { - final Entry e = new Entry(); + final ConfigLine e = new ConfigLine(); e.section = section; e.subsection = subsection; e.name = name; @@ -910,20 +910,21 @@ private State replaceStringList(final State srcState, return newState(entries); } - private static List copy(final State src, final List values) { + private static List copy(final ConfigSnapshot src, + final List values) { // At worst we need to insert 1 line for each value, plus 1 line // for a new section header. Assume that and allocate the space. // final int max = src.entryList.size() + values.size() + 1; - final ArrayList r = new ArrayList(max); + final ArrayList r = new ArrayList(max); r.addAll(src.entryList); return r; } - private static int findSectionEnd(final List entries, + private static int findSectionEnd(final List entries, final String section, final String subsection) { for (int i = 0; i < entries.size(); i++) { - Entry e = entries.get(i); + ConfigLine e = entries.get(i); if (e.match(section, subsection, null)) { i++; while (i < entries.size()) { @@ -944,7 +945,7 @@ private static int findSectionEnd(final List entries, */ public String toText() { final StringBuilder out = new StringBuilder(); - for (final Entry e : state.get().entryList) { + for (final ConfigLine e : state.get().entryList) { if (e.prefix != null) out.append(e.prefix); if (e.section != null && e.name == null) { @@ -994,10 +995,10 @@ public String toText() { * made to {@code this}. */ public void fromText(final String text) throws ConfigInvalidException { - final List newEntries = new ArrayList(); + final List newEntries = new ArrayList(); final StringReader in = new StringReader(text); - Entry last = null; - Entry e = new Entry(); + ConfigLine last = null; + ConfigLine e = new ConfigLine(); for (;;) { int input = in.read(); if (-1 == input) @@ -1009,7 +1010,7 @@ public void fromText(final String text) throws ConfigInvalidException { newEntries.add(e); if (e.section != null) last = e; - e = new Entry(); + e = new ConfigLine(); } else if (e.suffix != null) { // Everything up until the end-of-line is in the suffix. @@ -1056,12 +1057,14 @@ public void fromText(final String text) throws ConfigInvalidException { state.set(newState(newEntries)); } - private State newState() { - return new State(Collections. emptyList(), getBaseState()); + private ConfigSnapshot newState() { + return new ConfigSnapshot(Collections. emptyList(), + getBaseState()); } - private State newState(final List entries) { - return new State(Collections.unmodifiableList(entries), getBaseState()); + private ConfigSnapshot newState(final List entries) { + return new ConfigSnapshot(Collections.unmodifiableList(entries), + getBaseState()); } /** @@ -1279,7 +1282,7 @@ public boolean equals(Object other) { public Set parse(Config cfg) { final Set result = new LinkedHashSet(); while (cfg != null) { - for (final Entry e : cfg.state.get().entryList) { + for (final ConfigLine e : cfg.state.get().entryList) { if (e.subsection != null && e.name == null && StringUtils.equalsIgnoreCase(section, e.section)) result.add(e.subsection); @@ -1332,7 +1335,7 @@ public boolean equals(Object obj) { public Set parse(Config cfg) { final Map m = new LinkedHashMap(); while (cfg != null) { - for (final Entry e : cfg.state.get().entryList) { + for (final ConfigLine e : cfg.state.get().entryList) { if (e.name == null) continue; if (!StringUtils.equalsIgnoreCase(section, e.section)) @@ -1355,7 +1358,7 @@ private static class SectionNames implements SectionParser> { public Set parse(Config cfg) { final Map m = new LinkedHashMap(); while (cfg != null) { - for (final Entry e : cfg.state.get().entryList) { + for (final ConfigLine e : cfg.state.get().entryList) { if (e.section != null) { String lc = StringUtils.toLowerCase(e.section); if (!m.containsKey(lc)) @@ -1396,109 +1399,6 @@ public int size() { } } - private static class State { - final List entryList; - - final Map cache; - - final State baseState; - - State(List entries, State base) { - entryList = entries; - cache = new ConcurrentHashMap(16, 0.75f, 1); - baseState = base; - } - } - - /** - * The configuration file entry - */ - private static class Entry { - - /** - * The text content before entry - */ - String prefix; - - /** - * The section name for the entry - */ - String section; - - /** - * Subsection name - */ - String subsection; - - /** - * The key name - */ - String name; - - /** - * The value - */ - String value; - - /** - * The text content after entry - */ - String suffix; - - Entry forValue(final String newValue) { - final Entry e = new Entry(); - e.prefix = prefix; - e.section = section; - e.subsection = subsection; - e.name = name; - e.value = newValue; - e.suffix = suffix; - return e; - } - - boolean match(final String aSection, final String aSubsection, - final String aKey) { - return eqIgnoreCase(section, aSection) - && eqSameCase(subsection, aSubsection) - && eqIgnoreCase(name, aKey); - } - - boolean match(final String aSection, final String aSubsection) { - return eqIgnoreCase(section, aSection) - && eqSameCase(subsection, aSubsection); - } - - private static boolean eqIgnoreCase(final String a, final String b) { - if (a == null && b == null) - return true; - if (a == null || b == null) - return false; - return StringUtils.equalsIgnoreCase(a, b); - } - - private static boolean eqSameCase(final String a, final String b) { - if (a == null && b == null) - return true; - if (a == null || b == null) - return false; - return a.equals(b); - } - - @Override - public String toString() { - if (section == null) - return ""; - StringBuilder b = new StringBuilder(section); - if (subsection != null) - b.append(".").append(subsection); - if (name != null) - b.append(".").append(name); - if (value != null) - b.append("=").append(value); - return b.toString(); - } - } - private static class StringReader { private final char[] buf; diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/ConfigLine.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/ConfigLine.java new file mode 100644 index 000000000..2715f5f94 --- /dev/null +++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/ConfigLine.java @@ -0,0 +1,128 @@ +/* + * Copyright (C) 2010, Mathias Kinzler + * Copyright (C) 2009, Constantine Plotnikov + * Copyright (C) 2007, Dave Watson + * Copyright (C) 2008-2010, Google Inc. + * Copyright (C) 2009, Google, Inc. + * Copyright (C) 2009, JetBrains s.r.o. + * Copyright (C) 2007-2008, Robin Rosenberg + * Copyright (C) 2006-2008, Shawn O. Pearce + * Copyright (C) 2008, Thad Hughes + * and other copyright owners as documented in the project's IP log. + * + * This program and the accompanying materials are made available + * under the terms of the Eclipse Distribution License v1.0 which + * accompanies this distribution, is reproduced below, and is + * available at http://www.eclipse.org/org/documents/edl-v10.php + * + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or + * without modification, are permitted provided that the following + * conditions are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * - Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following + * disclaimer in the documentation and/or other materials provided + * with the distribution. + * + * - Neither the name of the Eclipse Foundation, Inc. nor the + * names of its contributors may be used to endorse or promote + * products derived from this software without specific prior + * written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, + * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +package org.eclipse.jgit.lib; + +import org.eclipse.jgit.util.StringUtils; + +/** A line in a Git {@link Config} file. */ +class ConfigLine { + /** The text content before entry. */ + String prefix; + + /** The section name for the entry. */ + String section; + + /** Subsection name. */ + String subsection; + + /** The key name. */ + String name; + + /** The value. */ + String value; + + /** The text content after entry. */ + String suffix; + + ConfigLine forValue(final String newValue) { + final ConfigLine e = new ConfigLine(); + e.prefix = prefix; + e.section = section; + e.subsection = subsection; + e.name = name; + e.value = newValue; + e.suffix = suffix; + return e; + } + + boolean match(final String aSection, final String aSubsection, + final String aKey) { + return eqIgnoreCase(section, aSection) + && eqSameCase(subsection, aSubsection) + && eqIgnoreCase(name, aKey); + } + + boolean match(final String aSection, final String aSubsection) { + return eqIgnoreCase(section, aSection) + && eqSameCase(subsection, aSubsection); + } + + private static boolean eqIgnoreCase(final String a, final String b) { + if (a == null && b == null) + return true; + if (a == null || b == null) + return false; + return StringUtils.equalsIgnoreCase(a, b); + } + + private static boolean eqSameCase(final String a, final String b) { + if (a == null && b == null) + return true; + if (a == null || b == null) + return false; + return a.equals(b); + } + + @Override + public String toString() { + if (section == null) + return ""; + StringBuilder b = new StringBuilder(section); + if (subsection != null) + b.append(".").append(subsection); + if (name != null) + b.append(".").append(name); + if (value != null) + b.append("=").append(value); + return b.toString(); + } +} diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/ConfigSnapshot.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/ConfigSnapshot.java new file mode 100644 index 000000000..61e4e0c93 --- /dev/null +++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/ConfigSnapshot.java @@ -0,0 +1,68 @@ +/* + * Copyright (C) 2010, Mathias Kinzler + * Copyright (C) 2009, Constantine Plotnikov + * Copyright (C) 2007, Dave Watson + * Copyright (C) 2008-2010, Google Inc. + * Copyright (C) 2009, Google, Inc. + * Copyright (C) 2009, JetBrains s.r.o. + * Copyright (C) 2007-2008, Robin Rosenberg + * Copyright (C) 2006-2008, Shawn O. Pearce + * Copyright (C) 2008, Thad Hughes + * and other copyright owners as documented in the project's IP log. + * + * This program and the accompanying materials are made available + * under the terms of the Eclipse Distribution License v1.0 which + * accompanies this distribution, is reproduced below, and is + * available at http://www.eclipse.org/org/documents/edl-v10.php + * + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or + * without modification, are permitted provided that the following + * conditions are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * - Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following + * disclaimer in the documentation and/or other materials provided + * with the distribution. + * + * - Neither the name of the Eclipse Foundation, Inc. nor the + * names of its contributors may be used to endorse or promote + * products derived from this software without specific prior + * written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, + * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +package org.eclipse.jgit.lib; + +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +class ConfigSnapshot { + final List entryList; + final Map cache; + final ConfigSnapshot baseState; + + ConfigSnapshot(List entries, ConfigSnapshot base) { + entryList = entries; + cache = new ConcurrentHashMap(16, 0.75f, 1); + baseState = base; + } +}