squid:CommentedOutCodeLine - Sections of code should not be "commented out".

README.md

@@ -2,7 +2,7 @@
 
 ![License](http://img.shields.io/:license-apache-blue.svg)
 [![Gitter](https://badges.gitter.im/davidsowerby/krail.svg)](https://gitter.im/davidsowerby/krail?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
-[![Build Status](https://travis-ci.org/davidsowerby/krailkrail.svg?branch=master)](https://travis-ci.org/davidsowerby/krail)
+[![Build Status](https://travis-ci.org/davidsowerby/krail.svg?branch=master)](https://travis-ci.org/davidsowerby/krail)
 [![Coverage Status](https://coveralls.io/repos/github/davidsowerby/krail/badge.svg?branch=master)](https://coveralls.io/github/davidsowerby/krail?branch=master)
 
 Krail provides a framework for rapid Java web development by combining Vaadin, Guice, Apache Shiro, Apache Commons Configuration and others.  For more information, see the comprehensive [Tutorial](http://krail.readthedocs.org/en/master/), which also makes a reasonable demo.  (You can clone directly from the [Tutorial repo](https://github.com/davidsowerby/krail-tutorial))

src/main/java/uk/q3c/krail/core/i18n/DefaultCurrentLocale.java

@@ -173,7 +173,6 @@ public void setLocale(Locale locale, boolean fireListeners) {
 
             if (locale != this.locale) {
                 this.locale = locale;
-                //                Locale.setDefault(locale);
                 log.debug("CurrentLocale set to {}", locale);
                 if (fireListeners) {
                     log.debug("publish locale change");

src/main/java/uk/q3c/krail/core/i18n/DefaultTranslate.java

@@ -96,7 +96,6 @@ public String from(boolean checkLocaleIsSupported, @Nullable I18NKey key, @Nonnu
         if (key == null) {
             return "key is null";
         }
-        //        E k = typeBridge(key);
         String pattern = patternSource.retrievePattern((Enum) key, locale);
 
 

src/main/java/uk/q3c/krail/core/navigate/StandardPageMappingReader.java

@@ -39,10 +39,6 @@ public PageRecord deconstruct(String line, int lineNumber) {
             syntaxErrors.add(missingLabelKeyMsg + " at line " + lineNumber);
             return null;
         }
-        // if (!line.contains(":")) {
-        // syntaxErrors.add(missingViewMsg + " at line " + lineNumber);
-        // return null;
-        // }
         if (!line.contains("=")) {
             syntaxErrors.add(missingUriMsg + " at line " + lineNumber);
             return null;

src/main/java/uk/q3c/krail/core/navigate/sitemap/DefaultMasterSitemap.java

@@ -44,7 +44,6 @@ public synchronized MasterSitemapNode append(NodeRecord nodeRecord) {
         // find the node (parent) to attach to, by looping and removing the trailing segment each
         // time until we find a matching node or run out of segments
         List<String> segments = new ArrayList(navState.getPathSegments());
-//        segments.remove(segments.size() - 1);
 
         MasterSitemapNode node = null;
         while ((segments.size() > 0) && (node == null)) {

src/main/java/uk/q3c/krail/core/navigate/sitemap/DefaultSitemapFinisher.java

@@ -211,7 +211,6 @@ private void redirectCheck(MasterSitemap sitemap) {
             } catch (CycleDetectedException cde) {
                 String msg = MessageFormat.format("Redirecting {0} to {1} would cause a loop", entry.getKey(), entry.getValue());
                 redirectLoops.add(msg);
-                // throw new CycleDetectedException(msg);
             }
 
         }

src/main/java/uk/q3c/krail/core/navigate/sitemap/DefaultUserSitemap.java

@@ -133,9 +133,6 @@ public synchronized void buildUriMap() {
     public boolean hasNoVisibleChildren(@Nonnull UserSitemapNode sourceNode) {
         checkNotNull(sourceNode);
         List<UserSitemapNode> children = this.getChildren(sourceNode);
-//        if (children == null) { //FindBugs reports this unnecessary
-//            return true;
-//        }
         for (UserSitemapNode child : children) {
             if (child.getPositionIndex() >= 0) {
                 return false;

src/main/java/uk/q3c/krail/core/navigate/sitemap/StandardPagesModule.java

@@ -19,9 +19,6 @@
 
 public class StandardPagesModule extends DirectSitemapModule {
 
-    // private MapBinder<String, StandardPageSitemapEntry> mapBinder;
-    // private MapBinder<String, RedirectEntry> redirectBinder;
-
     /**
      * Override this method to define different {@link MasterSitemap} entries for Standard Pages. All of the views
      * specified

src/main/java/uk/q3c/krail/core/shiro/DefaultShiroModule.java

@@ -1,4 +1,4 @@
-/*
+ /*
  *
  *  * Copyright (c) 2016. David Sowerby
  *  *

src/main/java/uk/q3c/krail/core/shiro/KrailErrorHandler.java

@@ -38,7 +38,6 @@ public class KrailErrorHandler extends DefaultErrorHandler {
     private final NotAGuestExceptionHandler notAGuestExceptionHandler;
     private final NotAUserExceptionHandler notAUserExceptionHandler;
     private final UnauthorizedExceptionHandler authorisationHandler;
-    //    private final InvalidURIHandler invalidUriHandler;
     private final Navigator navigator;
     private UserNotifier userNotifier;
 

src/main/java/uk/q3c/krail/core/sysadmin/I18NView.java

@@ -96,24 +96,6 @@ protected void doBuild(ViewChangeBusMessage busMessage) {
     protected void export() {
 
         userNotifier.notifyInformation(LabelKey.This_feature_has_not_been_implemented);
-        //        exportStatus.setValue("");
-        //        Optional<DatabaseBundleWriter> writerOpt = findWriter();
-        //        Set<Locale> locales = retrieveLocales();
-        //        if (locales.isEmpty()) {
-        //            userNotifier.notifyInformation(MessageKey.There_are_no_Locales_to_process);
-        //            return;
-        //        }
-        //        if (writerOpt.isPresent()) {
-        //            try {
-        //                patternUtility.writeExclusive(locales, writerOpt.get());
-        //                exportStatus.setValue(translate.from(MessageKey.Keys_exported, writerOpt.get()
-        //                                                                                        .count(), locales.size()));
-        //                userNotifier.notifyInformation(LabelKey.Export_complete);
-        //            } catch (Exception e) {
-        //                log.info("Export I18NKeys failed due to exception", e);
-        //                userNotifier.notifyError(MessageKey.I18NKey_export_failed, e.getMessage());
-        //            }
-        //        }
     }
 
     @Handler
@@ -123,43 +105,5 @@ public void localeChanged(LocaleChangeBusMessage busMessage) {
         instructions2.setValue('\n' + translate.from(MessageKey.All_Keys_exported));
     }
 
-    //    private Optional<DatabaseBundleWriter> findWriter() {
-    //        exportStatus.setValue(translate.from(LabelKey.Looking_for_Database_Writer));
-    //        Reflections reflections = new Reflections();
-    //        final Set<Class<? extends DatabaseBundleWriter>> writers = reflections.getSubTypesOf(DatabaseBundleWriter.class);
-    //        writers.remove(DatabaseBundleWriterBase.class);
-    //        if (writers.size() == 1) {
-    //            return Optional.of(injector.getInstance(writers.iterator()
-    //                                                           .next()));
-    //        }
-    //        if (writers.size() == 0) {
-    //            userNotifier.notifyWarning(MessageKey.Needs_at_least_one_database_writer);
-    //            return Optional.empty();
-    //        }
-    //        userNotifier.notifyWarning(MessageKey.Currently_limited_to_supporting_one_database_writer);
-    //        return Optional.empty();
-    //    }
-
-//    @Nonnull
-//    protected Set<Locale> retrieveLocales() {
-//        exportStatus.setValue(translate.from(LabelKey.Retrieving_Locales));
-//        String userInput = localeList.getValue();
-//        List<String> localeTags = Splitter.on("\n")
-//                                          .trimResults()
-//                                          .omitEmptyStrings()
-//                                          .splitToList(userInput);
-//        Set<Locale> locales = new HashSet<>();
-//        localeTags.forEach(tag -> {
-//            try {
-//                Locale locale = new Locale.Builder().setLanguageTag(tag)
-//                                                    .build();
-//                locales.add(locale);
-//            } catch (IllformedLocaleException e) {
-//                userNotifier.notifyWarning(MessageKey.Invalid_Locale_Langugage_Tag, tag);
-//            }
-//        });
-//        return locales;
-//    }
-
 
 }

src/main/java/uk/q3c/krail/core/sysadmin/SitemapReportView.java

@@ -48,7 +48,6 @@ protected SitemapReportView(MasterSitemap masterSitemap, Translate translate) {
     protected void doBuild(ViewChangeBusMessage busMessage) {
         super.doBuild(busMessage);
         reportArea = new TextArea();
-        //        reportArea.setEnabled(false);
         reportArea.setSizeFull();
         reportArea.setValue(masterSitemap.getReport());
         setCentreCell(reportArea);

src/main/java/uk/q3c/krail/core/sysadmin/option/SourcePanel.java

@@ -124,13 +124,11 @@ protected SourcePanel(Translate translate, OptionSource optionSource, Option opt
     }
 
     private void styles() {
-//        String defaultCaptionStyleName = option.get(defaultCaptionStyleOptionKey);
         applyStyle(nameCaption, nameCaptionStyleOptionKey);
         applyStyle(descriptionCaption, descriptionCaptionStyleOptionKey);
         applyStyle(connectionUrlCaption, connectionUrlCaptionStyleOptionKey);
         applyStyle(volatileCaption, is_volatileCaptionStyleOptionKey);
 
-//        String defaultValueStyleName = option.get(defaultValueStyleOptionKey);
         applyStyle(nameLabel, nameValueStyleOptionKey);
         applyStyle(descriptionLabel, descriptionValueStyleOptionKey);
         applyStyle(connectionUrlLabel, connectionUrlValueStyleOptionKey);

src/main/java/uk/q3c/krail/core/view/component/DefaultUserStatusPanel.java

@@ -72,7 +72,6 @@ protected DefaultUserStatusPanel(Navigator navigator, SubjectProvider subjectPro
         this.subjectIdentifier = subjectIdentifier;
         this.eventBus = eventBusProvider.get();
         this.currentLocale = currentLocale;
-        //        eventBus.subscribe(this);
         setSizeFull();
         addStyleName(ChameleonTheme.PANEL_BORDERLESS);
         usernameLabel = new Label();

src/main/java/uk/q3c/krail/testutil/i18n/MockCurrentLocale.java

@@ -56,7 +56,6 @@ public void setLocale(Locale locale, boolean fireListeners) {
 
         if (locale != this.locale) {
             this.locale = locale;
-            //                Locale.setDefault(locale);
             log.debug("CurrentLocale set to {}", locale);
             if (fireListeners) {
                 log.debug("publish locale change");

src/main/java/uk/q3c/util/SourceTreeWrapper.java

@@ -29,10 +29,6 @@
  */
 public interface SourceTreeWrapper<N> {
 
-    // public abstract boolean hasChildren(N parentNode);
-
-    // public abstract int getChildCount(N parentNode);
-
     public abstract List<N> getRoots();
 
     /**
@@ -44,15 +40,10 @@ public interface SourceTreeWrapper<N> {
      */
     public abstract List<N> getChildren(N parentNode);
 
-    // public abstract void addNode(N parentNode, N childNode);
-
     /**
      * Called by {@link TreeCopy} to offer the chance to mark this node as not having any children. Not used by all
      * implementations
      *
      * @param isLeaf
      */
-    // public abstract void setLeaf(N parentNode, boolean isLeaf);
-
-    // public boolean hasParent(N childNode);
 }

src/main/java/uk/q3c/util/SourceTreeWrapper_BasicForest.java

@@ -18,21 +18,11 @@ public class SourceTreeWrapper_BasicForest<S> implements SourceTreeWrapper<S> {
 
     private final BasicForest<S> forest;
 
-    // private NodeModifier<S, T> nodeModifier = new DefaultNodeModifier<S, T>();
-
     public SourceTreeWrapper_BasicForest(BasicForest<S> forest) {
         super();
         this.forest = forest;
     }
 
-    // public NodeModifier<S, T> getNodeModifier() {
-    // return nodeModifier;
-    // }
-
-    // public void setNodeModifier(NodeModifier<S, T> nodeModifier) {
-    // this.nodeModifier = nodeModifier;
-    // }
-
     @Override
     public List<S> getRoots() {
         return forest.getRoots();

src/test/java/fixture/ReferenceUserSitemap.java

@@ -210,11 +210,6 @@ private void createStandardPages() {
         addChild(publicNode, loginNode);
         addChild(publicNode, logoutNode);
         addChild(privateNode, privateHomeNode);
-
-        //        addStandardPage(StandardPageKey.Log_In, loginNode);
-        //        addStandardPage(StandardPageKey.Log_Out, logoutNode);
-        //        addStandardPage(StandardPageKey.Public_Home, publicHomeNode);
-        //        addStandardPage(StandardPageKey.Private_Home, privateHomeNode);
     }
 
     public UserSitemapNode createNode(String fullURI, String uriSegment, Class<? extends KrailView> viewClass, I18NKey labelKey, PageAccessControl

src/test/java/fixture/testviews2/My_AccountView.java

@@ -34,7 +34,6 @@ public void buildView(ViewChangeBusMessage busMessage) {
 
     @Override
     public Component getRootComponent() {
-        // return null;
         throw new RuntimeException("not yet implemented");
     }
 

src/test/java/fixture/testviews2/PrivateView.java

@@ -31,7 +31,6 @@ public void buildView(ViewChangeBusMessage busMessage) {
 
     @Override
     public Component getRootComponent() {
-        // return null;
         throw new RuntimeException("not yet implemented");
     }
 

src/test/java/fixture/testviews2/ViewA1.java

@@ -33,7 +33,6 @@ public void buildView(ViewChangeBusMessage busMessage) {
 
     @Override
     public Component getRootComponent() {
-        // return null;
         throw new RuntimeException("not yet implemented");
     }
 

src/test/java/fixture/testviews2/ViewA11.java

@@ -33,7 +33,6 @@ public void buildView(ViewChangeBusMessage busMessage) {
 
     @Override
     public Component getRootComponent() {
-        // return null;
         throw new RuntimeException("not yet implemented");
     }
 

src/test/java/fixture/testviews2/ViewA111.java

@@ -33,7 +33,6 @@ public void buildView(ViewChangeBusMessage busMessage) {
 
     @Override
     public Component getRootComponent() {
-        // return null;
         throw new RuntimeException("not yet implemented");
     }
 

src/test/java/fixture/testviews2/WigglyHomeView.java

@@ -33,7 +33,6 @@ public void buildView(ViewChangeBusMessage busMessage) {
 
     @Override
     public Component getRootComponent() {
-        // return null;
         throw new RuntimeException("not yet implemented");
     }
 

src/test/java/uk/q3c/krail/core/guice/DefaultBindingManagerTest.java

@@ -78,8 +78,6 @@ public void setup() {
     @Test
     public void startAndStop() throws Exception {
 
-        //then
-//        assertThat(DefaultBindingManager.injector()).isNull();
         // given
         TestBindingManager bindingManager = new TestBindingManager();
         when(servletContextEvent.getServletContext()).thenReturn(servletContext);

src/test/java/uk/q3c/krail/core/guice/uiscope/UIScopeTest.java

@@ -103,7 +103,6 @@ public void uiScope2() {
 
         // given
         KrailSecurityManager securityManager = new KrailSecurityManager(cacheManagerOpt);
-        //        securityManager.setVaadinSessionProvider(vaadinSessionProvider);
 
         SecurityUtils.setSecurityManager(securityManager);
 

src/test/java/uk/q3c/krail/core/i18n/DefaultCurrentLocaleTest.java

@@ -245,7 +245,6 @@ public void setLocaleNoFire() {
         currentLocale.setLocale(Locale.FRANCE, false);
         // then
         assertThat(listenerFired).isFalse();
-        //        assertThat(Locale.getDefault()).isEqualTo(Locale.FRANCE);
     }
 
     @Test
@@ -260,7 +259,6 @@ public void setLocaleFire() {
         currentLocale.setLocale(Locale.FRANCE, true);
         // then
         assertThat(listenerFired).isTrue();
-        //        assertThat(Locale.getDefault()).isEqualTo(Locale.FRANCE);
     }
 
     @Test

src/test/java/uk/q3c/krail/core/i18n/DefaultI18NProcessorTest.java

@@ -92,7 +92,6 @@ public void interpret() {
                              .getCaption()).isEqualTo("Ok");
         assertThat(testObject.getLabel()
                              .getDescription()).isEqualTo("Confirm this Value is Ok");
-        // assertThat(testObject.getLabel().getValue()).isEqualTo("Ok");
         assertThat(testObject.getLabel()
                              .getLocale()).isEqualTo(Locale.UK);
 
@@ -116,20 +115,17 @@ public void interpret() {
         assertThat(ccs.getCaption()).isEqualTo("Field");
         assertThat(ccs.getLabelInsideTcc()).isNotNull();
         Label label = ccs.getLabelInsideTcc();
-        // assertThat(label.getValue()).isEqualTo("Ok");
         assertThat(label.getDescription()).isEqualTo("Confirm this Value is Ok"); //drill down needed
 
         // class annotation
         TestCompositeComponent ccc = testObject.getCcc();
         assertThat(ccc.getCaption()).isEqualTo("Class");
         assertThat(ccc.getLabelInsideTcc()).isNotNull();
         label = ccc.getLabelInsideTcc();
-        // assertThat(label.getValue()).isEqualTo("Ok");
         assertThat(label.getDescription()).isEqualTo("Confirm this Value is Ok");
 
         // composite but not a component
         TestCompositeNonComponent cnc = testObject.getCnc();
-        // assertThat(cnc.getLabel().getValue()).isEqualTo("Cancel");
 
         // nested component
         TestCompositeComponentNested ccn = testObject.getCcn();
@@ -175,7 +171,6 @@ public void interpret_de() {
                              .getCaption()).isEqualTo("OK");
         assertThat(testObject.getLabel()
                              .getDescription()).isEqualTo(confirmValueOk);
-        // assertThat(testObject.getLabel().getValue()).isEqualTo("Ok");
         assertThat(testObject.getButtonWithAnnotation()
                              .getLocale()).isEqualTo(Locale.GERMANY);
 

src/test/java/uk/q3c/krail/core/navigate/DefaultNavigatorTest.java

@@ -210,8 +210,6 @@ public void logout_rule_invoked() {
     public void login_rule_invoked() {
 
         // given
-
-        //        assertThat(loginNavigationRule.changedNavigationState(navigator,loginSource)).isNotNull();
         navigator = createNavigator();
         when(loginNavigationRule.changedNavigationState(navigator, loginSource)).thenReturn(Optional.empty());
         // when

src/test/java/uk/q3c/krail/core/navigate/LabelKeyForNameTest.java

@@ -22,18 +22,6 @@
 
 public class LabelKeyForNameTest {
 
-    // @Test
-    // public void test() {
-    // List<String> names = new ArrayList<>();
-    // Class<? extends Enum<?>> enumClass = LabelKeys.class;
-    // Enum<?>[] enums = enumClass.getEnumConstants();
-    // for (Enum<?> e : enums) {
-    // System.out.println(e.name());
-    // names.add(e.name());
-    // }
-    //
-    // }
-
     @Test
     public void keyForName_good() {