org.craftercms.commons.upgrade.impl.providers.AbstractFileVersionProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of crafter-commons-upgrade-manager Show documentation

Crafter Commons Upgrade Manager

There is a newer version: 4.2.0

Show newest version

 /*
  * Copyright (C) 2007-2022 Crafter Software Corporation. All Rights Reserved.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as published by
  * the Free Software Foundation.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see .
  */
 package org.craftercms.commons.upgrade.impl.providers;

 import org.craftercms.commons.upgrade.impl.UpgradeContext;

 import java.io.File;
 import java.nio.file.Path;
 import java.nio.file.Paths;

 /**
  * Base class for all {@link org.craftercms.commons.upgrade.VersionProvider} that use files
  *
  * @param  The target type supported
  * @author joseross
  * @since 3.1.5
  */
 public abstract class AbstractFileVersionProvider extends AbstractVersionProvider {

     protected Path getFile(UpgradeContext context) {
         var target = context.getTarget();
         if (target instanceof String) {
             return Paths.get((String) target);
         } else if (target instanceof File) {
             return ((File) target).toPath();
         } else if (target instanceof Path) {
             return (Path) target;
         } else {
             throw new IllegalArgumentException("Target can't be converted to Path: " + target);
         }
     }

     @Override
     protected String doGetVersion(final UpgradeContext context) throws Exception {
         Path file = getFile(context);
         return readVersionFromFile(file);
     }

     @Override
     protected void doSetVersion(final UpgradeContext context, final String version) throws Exception {
         Path file = getFile(context);
         writeVersionToFile(file, version);
     }

     protected abstract String readVersionFromFile(Path file) throws Exception;

     protected abstract void writeVersionToFile(Path file, String version) throws Exception;

 }