Package jmri.jmrit.vsdecoder

Class VSDFile

java.lang.Object

java.util.zip.ZipFile

jmri.jmrit.vsdecoder.VSDFile

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class VSDFile
extends java.util.zip.ZipFile

Open a VSD file and validate the configuration part. This file is part of JMRI.

JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.

JMRI 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	VSDFile.ValidateStatus

Field Summary

Fields

Modifier and Type	Field	Description
static int	CENATT
static int	CENATX
static int	CENCOM
static int	CENCRC
static int	CENDSK
static int	CENEXT
static int	CENFLG
static int	CENHDR
static int	CENHOW
static int	CENLEN
static int	CENNAM
static int	CENOFF
static long	CENSIG
static int	CENSIZ
static int	CENTIM
static int	CENVEM
static int	CENVER
static int	ENDCOM
static int	ENDHDR
static int	ENDOFF
static long	ENDSIG
static int	ENDSIZ
static int	ENDSUB
static int	ENDTOT
static int	EXTCRC
static int	EXTHDR
static int	EXTLEN
static long	EXTSIG
static int	EXTSIZ
protected boolean	initialized
static int	LOCCRC
static int	LOCEXT
static int	LOCFLG
static int	LOCHDR
static int	LOCHOW
static int	LOCLEN
static int	LOCNAM
static long	LOCSIG
static int	LOCSIZ
static int	LOCTIM
static int	LOCVER
protected org.jdom2.Element	root

Fields inherited from class java.util.zip.ZipFile

OPEN_DELETE, OPEN_READ

Constructor Summary

Constructors

Constructor	Description
VSDFile(java.io.File file)
VSDFile(java.io.File file, int mode)
VSDFile(java.lang.String name)

Method Summary

Modifier and Type	Method	Description
java.io.File	getFile(java.lang.String name)
java.io.InputStream	getInputStream(java.lang.String name)
org.jdom2.Element	getRoot()
java.lang.String	getStatusMessage()
java.lang.String	getURL(java.lang.String name)
protected boolean	init()
boolean	isInitialized()
VSDFile.ValidateStatus	validate(org.jdom2.Element xmlroot)
protected boolean	validateFiles(org.jdom2.Element el, java.lang.String name, java.lang.String[] fnames)
protected boolean	validateFiles(org.jdom2.Element el, java.lang.String name, java.lang.String[] fnames, java.lang.Boolean required)
protected boolean	validateFilesNumbers(org.jdom2.Element el, java.lang.String name, java.lang.String[] fnames, java.lang.Boolean required)
protected boolean	validateOptionalFile(org.jdom2.Element el, java.lang.String name)
protected boolean	validateOptionalFile(org.jdom2.Element el, java.lang.String name, java.lang.Boolean required)
protected boolean	validateRequiredElement(org.jdom2.Element el, java.lang.String name)
protected boolean	validateRequiredElementRange(org.jdom2.Element el, java.lang.String name, int val_from, int val_to)
protected boolean	validateRequiredNotchElement(org.jdom2.Element el, java.lang.String name1, java.lang.String name2)

Methods inherited from class java.util.zip.ZipFile

close, entries, finalize, getComment, getEntry, getInputStream, getName, size, stream

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

root

protected org.jdom2.Element root

initialized

protected boolean initialized

LOCSIG

public static final long LOCSIG

See Also:

Constant Field Values

EXTSIG

public static final long EXTSIG

See Also:

Constant Field Values

CENSIG

public static final long CENSIG

See Also:

Constant Field Values

ENDSIG

public static final long ENDSIG

See Also:

Constant Field Values

LOCHDR

public static final int LOCHDR

See Also:

Constant Field Values

EXTHDR

public static final int EXTHDR

See Also:

Constant Field Values

CENHDR

public static final int CENHDR

See Also:

Constant Field Values

ENDHDR

public static final int ENDHDR

See Also:

Constant Field Values

LOCVER

public static final int LOCVER

See Also:

Constant Field Values

LOCFLG

public static final int LOCFLG

See Also:

Constant Field Values

LOCHOW

public static final int LOCHOW

See Also:

Constant Field Values

LOCTIM

public static final int LOCTIM

See Also:

Constant Field Values

LOCCRC

public static final int LOCCRC

See Also:

Constant Field Values

LOCSIZ

public static final int LOCSIZ

See Also:

Constant Field Values

LOCLEN

public static final int LOCLEN

See Also:

Constant Field Values

LOCNAM

public static final int LOCNAM

See Also:

Constant Field Values

LOCEXT

public static final int LOCEXT

See Also:

Constant Field Values

EXTCRC

public static final int EXTCRC

See Also:

Constant Field Values

EXTSIZ

public static final int EXTSIZ

See Also:

Constant Field Values

EXTLEN

public static final int EXTLEN

See Also:

Constant Field Values

CENVEM

public static final int CENVEM

See Also:

Constant Field Values

CENVER

public static final int CENVER

See Also:

Constant Field Values

CENFLG

public static final int CENFLG

See Also:

Constant Field Values

CENHOW

public static final int CENHOW

See Also:

Constant Field Values

CENTIM

public static final int CENTIM

See Also:

Constant Field Values

CENCRC

public static final int CENCRC

See Also:

Constant Field Values

CENSIZ

public static final int CENSIZ

See Also:

Constant Field Values

CENLEN

public static final int CENLEN

See Also:

Constant Field Values

CENNAM

public static final int CENNAM

See Also:

Constant Field Values

CENEXT

public static final int CENEXT

See Also:

Constant Field Values

CENCOM

public static final int CENCOM

See Also:

Constant Field Values

CENDSK

public static final int CENDSK

See Also:

Constant Field Values

CENATT

public static final int CENATT

See Also:

Constant Field Values

CENATX

public static final int CENATX

See Also:

Constant Field Values

CENOFF

public static final int CENOFF

See Also:

Constant Field Values

ENDSUB

public static final int ENDSUB

See Also:

Constant Field Values

ENDTOT

public static final int ENDTOT

See Also:

Constant Field Values

ENDSIZ

public static final int ENDSIZ

See Also:

Constant Field Values

ENDOFF

public static final int ENDOFF

See Also:

Constant Field Values

ENDCOM

public static final int ENDCOM

See Also:

Constant Field Values

Constructor Detail

VSDFile

public VSDFile(java.io.File file)
        throws java.util.zip.ZipException,
               java.io.IOException

Throws:

java.util.zip.ZipException

java.io.IOException

VSDFile

public VSDFile(java.io.File file,
               int mode)
        throws java.util.zip.ZipException,
               java.io.IOException

Throws:

java.util.zip.ZipException

java.io.IOException

VSDFile

public VSDFile(java.lang.String name)
        throws java.util.zip.ZipException,
               java.io.IOException

Throws:

java.util.zip.ZipException

java.io.IOException

Method Detail

isInitialized

public boolean isInitialized()

getStatusMessage

public java.lang.String getStatusMessage()

init

protected boolean init()

getRoot

public org.jdom2.Element getRoot()

getInputStream

public java.io.InputStream getInputStream(java.lang.String name)

getFile

public java.io.File getFile(java.lang.String name)

getURL

public java.lang.String getURL(java.lang.String name)

validate

public VSDFile.ValidateStatus validate(org.jdom2.Element xmlroot)

validateRequiredElement

protected boolean validateRequiredElement(org.jdom2.Element el,
                                          java.lang.String name)

validateRequiredElementRange

protected boolean validateRequiredElementRange(org.jdom2.Element el,
                                               java.lang.String name,
                                               int val_from,
                                               int val_to)

validateRequiredNotchElement

protected boolean validateRequiredNotchElement(org.jdom2.Element el,
                                               java.lang.String name1,
                                               java.lang.String name2)

validateOptionalFile

protected boolean validateOptionalFile(org.jdom2.Element el,
                                       java.lang.String name)

validateOptionalFile

protected boolean validateOptionalFile(org.jdom2.Element el,
                                       java.lang.String name,
                                       java.lang.Boolean required)

validateFiles

protected boolean validateFiles(org.jdom2.Element el,
                                java.lang.String name,
                                java.lang.String[] fnames)

validateFiles

protected boolean validateFiles(org.jdom2.Element el,
                                java.lang.String name,
                                java.lang.String[] fnames,
                                java.lang.Boolean required)

validateFilesNumbers

protected boolean validateFilesNumbers(org.jdom2.Element el,
                                       java.lang.String name,
                                       java.lang.String[] fnames,
                                       java.lang.Boolean required)