From 2d4385d63b57471b8c8abd0581bd72a35e841d5f Mon Sep 17 00:00:00 2001 From: ebruchez Date: Mon, 16 Sep 2019 16:21:21 -0700 Subject: [PATCH] Following #4117: types, parameters, comments --- .../orbeon/oxf/xforms/XFormsContextStack.java | 2 +- .../control/ControlBindingSupport.scala | 10 +++++----- .../xforms/control/XFormsValueControl.scala | 6 +++--- .../control/controls/FileMetadata.scala | 2 +- .../controls/XFormsOutputControl.scala | 20 +++++++++---------- .../controls/XFormsSelectControl.scala | 2 -- 6 files changed, 20 insertions(+), 22 deletions(-) diff --git a/xforms/jvm/src/main/java/org/orbeon/oxf/xforms/XFormsContextStack.java b/xforms/jvm/src/main/java/org/orbeon/oxf/xforms/XFormsContextStack.java index d0d6ac8790..6344b2ccca 100644 --- a/xforms/jvm/src/main/java/org/orbeon/oxf/xforms/XFormsContextStack.java +++ b/xforms/jvm/src/main/java/org/orbeon/oxf/xforms/XFormsContextStack.java @@ -300,7 +300,7 @@ public void pushBinding( final boolean isNewModel; if (modelId != null) { final XBLContainer resolutionScopeContainer = container.findScopeRoot(scope); - final XFormsObject o = resolutionScopeContainer.resolveObjectById(sourceEffectiveId, modelId, Option.apply(null)); + final XFormsObject o = resolutionScopeContainer.resolveObjectById(sourceEffectiveId, modelId, Option.apply(null)); if (!(o instanceof XFormsModel)) { // Invalid model id diff --git a/xforms/jvm/src/main/scala/org/orbeon/oxf/xforms/control/ControlBindingSupport.scala b/xforms/jvm/src/main/scala/org/orbeon/oxf/xforms/control/ControlBindingSupport.scala index e23d6b61bc..985c7f2fa8 100644 --- a/xforms/jvm/src/main/scala/org/orbeon/oxf/xforms/control/ControlBindingSupport.scala +++ b/xforms/jvm/src/main/scala/org/orbeon/oxf/xforms/control/ControlBindingSupport.scala @@ -85,11 +85,11 @@ trait ControlBindingSupport { // Make sure the parent is updated, as ancestor bindings might have changed, and it is important to // ensure that the chain of bindings is consistent setBindingContext( - bindingContext.copy(parent = parentContext), - parentContentRelevant, - update = true, - restoreState = false, - None + bindingContext = bindingContext.copy(parent = parentContext), + parentRelevant = parentContentRelevant, + update = true, + restoreState = false, + state = None ) } diff --git a/xforms/jvm/src/main/scala/org/orbeon/oxf/xforms/control/XFormsValueControl.scala b/xforms/jvm/src/main/scala/org/orbeon/oxf/xforms/control/XFormsValueControl.scala index d05b726264..35208066c3 100644 --- a/xforms/jvm/src/main/scala/org/orbeon/oxf/xforms/control/XFormsValueControl.scala +++ b/xforms/jvm/src/main/scala/org/orbeon/oxf/xforms/control/XFormsValueControl.scala @@ -107,12 +107,12 @@ trait XFormsValueControl extends XFormsSingleNodeControl { null ) - protected def markExternalValueDirty(): Unit = { + final protected def markExternalValueDirty(): Unit = { isExternalValueEvaluated = false externalValue = null } - protected def isExternalValueDirty: Boolean = + final protected def isExternalValueDirty: Boolean = ! isExternalValueEvaluated override def isValueChangedCommit(): Boolean = { @@ -122,7 +122,7 @@ trait XFormsValueControl extends XFormsSingleNodeControl { } // This usually doesn't need to be overridden (only XFormsUploadControl as of 2012-08-15; 2019-09-04) - def storeExternalValue(externalValue: String) = + def storeExternalValue(externalValue: String): Unit = if (handleExternalValue) doStoreExternalValue(externalValue) else diff --git a/xforms/jvm/src/main/scala/org/orbeon/oxf/xforms/control/controls/FileMetadata.scala b/xforms/jvm/src/main/scala/org/orbeon/oxf/xforms/control/controls/FileMetadata.scala index ed4a90449f..7efe2697ae 100644 --- a/xforms/jvm/src/main/scala/org/orbeon/oxf/xforms/control/controls/FileMetadata.scala +++ b/xforms/jvm/src/main/scala/org/orbeon/oxf/xforms/control/controls/FileMetadata.scala @@ -63,7 +63,7 @@ trait FileMetadata extends XFormsValueControl { def supportedFileMetadata: Seq[String] // Evaluate all properties - def evaluateFileMetadata(relevant: Boolean) = + def evaluateFileMetadata(relevant: Boolean): Unit = props.values foreach (_.value) // Mark all properties dirty diff --git a/xforms/jvm/src/main/scala/org/orbeon/oxf/xforms/control/controls/XFormsOutputControl.scala b/xforms/jvm/src/main/scala/org/orbeon/oxf/xforms/control/controls/XFormsOutputControl.scala index eec5e2c783..45cd436e85 100644 --- a/xforms/jvm/src/main/scala/org/orbeon/oxf/xforms/control/controls/XFormsOutputControl.scala +++ b/xforms/jvm/src/main/scala/org/orbeon/oxf/xforms/control/controls/XFormsOutputControl.scala @@ -13,7 +13,7 @@ */ package org.orbeon.oxf.xforms.control.controls -import org.orbeon.dom.Element +import org.orbeon.dom.{Element, QName} import org.orbeon.exception.OrbeonFormatter import org.orbeon.oxf.externalcontext.{ServletURLRewriter, URLRewriter} import org.orbeon.oxf.util.StringUtils._ @@ -47,10 +47,10 @@ class XFormsOutputControl( override type Control <: OutputControl - def supportedFileMetadata = Seq("mediatype", "filename") // could add "state"? + def supportedFileMetadata: Seq[String] = Seq("mediatype", "filename") // could add "state"? // Optional format and mediatype - private def format = staticControlOpt flatMap (_.format) + private def format: Option[String] = staticControlOpt flatMap (_.format) // Value attribute private val valueAttributeOpt = element.attributeValueOpt(VALUE_QNAME) @@ -205,7 +205,7 @@ class XFormsOutputControl( defaultValue } - override def getRelevantEscapedExternalValue = + override def getRelevantEscapedExternalValue: String = if (appearances(XXFORMS_DOWNLOAD_APPEARANCE_QNAME) || (mediatype exists (_.startsWith("image/")))) { val externalValue = getExternalValue if (externalValue.nonBlank) { @@ -223,7 +223,7 @@ class XFormsOutputControl( // Return external value as is getExternalValue - override def getNonRelevantEscapedExternalValue = + override def getNonRelevantEscapedExternalValue: String = if (mediatype exists (_.startsWith("image/"))) // Return rewritten URL of dummy image URL XFormsUtils.resolveResourceURL(containingDocument, element, DUMMY_IMAGE_URI, URLRewriter.REWRITE_MODE_ABSOLUTE_PATH) @@ -232,15 +232,15 @@ class XFormsOutputControl( // If we have both @ref and @value, read the type // XForms doesn't specify this as of XForms 2.0, but we already read the other MIPs so it makes sense. - override def valueType = super.valueType + override def valueType: QName = super.valueType // It usually doesn't make sense to focus on xf:output, at least not in the sense "focus to enter data" // We make an exception for https://github.com/orbeon/orbeon-forms/issues/3583 override def isFocusable: Boolean = isRelevant && staticControl.hasLHHA(LHHA.Label) - override def addAjaxExtensionAttributes(attributesImpl: AttributesImpl, previousControlOpt: Option[XFormsControl]) = { - var added = super.addAjaxExtensionAttributes(attributesImpl, previousControlOpt) + override def addAjaxExtensionAttributes(attributesImpl: AttributesImpl, previousControlOpt: Option[XFormsControl]): Boolean = { + var added: Boolean = super.addAjaxExtensionAttributes(attributesImpl, previousControlOpt) added |= addFileMetadataAttributes(attributesImpl, previousControlOpt.asInstanceOf[Option[FileMetadata]]) added } @@ -256,7 +256,7 @@ class XFormsOutputControl( case _ ⇒ false } - override def findAriaByControlEffectiveId = + override def findAriaByControlEffectiveId: Option[String] = if (appearances(XXFORMS_DOWNLOAD_APPEARANCE_QNAME) || appearances(XXFORMS_TEXT_APPEARANCE_QNAME) || (mediatype exists (_.startsWith("image/"))) || @@ -274,7 +274,7 @@ class XFormsOutputControl( object XFormsOutputControl { - def getExternalValueOrDefault(control: XFormsOutputControl, mediatypeValue: String) = + def getExternalValueOrDefault(control: XFormsOutputControl, mediatypeValue: String): String = if ((control ne null) && control.isRelevant) // Ask control control.getExternalValue diff --git a/xforms/jvm/src/main/scala/org/orbeon/oxf/xforms/control/controls/XFormsSelectControl.scala b/xforms/jvm/src/main/scala/org/orbeon/oxf/xforms/control/controls/XFormsSelectControl.scala index 7366ccdac8..8fa9e7255e 100644 --- a/xforms/jvm/src/main/scala/org/orbeon/oxf/xforms/control/controls/XFormsSelectControl.scala +++ b/xforms/jvm/src/main/scala/org/orbeon/oxf/xforms/control/controls/XFormsSelectControl.scala @@ -84,8 +84,6 @@ class XFormsSelectControl( } override def markDirtyImpl(): Unit = { - - // Default implementation super.markDirtyImpl() if (! isExternalValueDirty && containingDocument.getXPathDependencies.requireItemsetUpdate(staticControl, effectiveId)) { // If the itemset has changed but the value has not changed, the external value might still need to be